Metadata-Version: 2.1
Name: pytask
Version: 0.0.14
Summary: In its highest aspirations, pytask tries to be pytest as a build system.
Home-page: https://github.com/pytask-dev/pytask
Author: Tobias Raabe
Author-email: raabe@posteo.de
License: MIT
Project-URL: Documentation, https://pytask-dev.readthedocs.io/en/latest
Project-URL: Github, https://github.com/pytask-dev/pytask
Project-URL: Tracker, https://github.com/pytask-dev/pytask/issues
Project-URL: Changelog, https://pytask-dev.readthedocs.io/en/latest/changes.html
Description: 
        .. start-badges
        
        .. image:: https://img.shields.io/pypi/v/pytask?color=blue
            :alt: PyPI
            :target: https://pypi.org/project/pytask
        
        .. image:: https://img.shields.io/pypi/pyversions/pytask
            :alt: PyPI - Python Version
            :target: https://pypi.org/project/pytask
        
        .. image:: https://img.shields.io/conda/vn/conda-forge/pytask.svg
            :target: https://anaconda.org/conda-forge/pytask
        
        .. image:: https://img.shields.io/conda/pn/conda-forge/pytask.svg
            :target: https://anaconda.org/conda-forge/pytask
        
        .. image:: https://img.shields.io/pypi/l/pytask
            :alt: PyPI - License
            :target: https://pypi.org/project/pytask
        
        .. image:: https://readthedocs.org/projects/pytask-dev/badge/?version=latest
            :target: https://pytask-dev.readthedocs.io/en/latest
        
        .. image:: https://img.shields.io/github/workflow/status/pytask-dev/pytask/Continuous%20Integration%20Workflow/main
           :target: https://github.com/pytask-dev/pytask/actions?query=branch%3Amain
        
        .. image:: https://codecov.io/gh/pytask-dev/pytask/branch/main/graph/badge.svg
            :target: https://codecov.io/gh/pytask-dev/pytask
        
        .. image:: https://results.pre-commit.ci/badge/github/pytask-dev/pytask/main.svg
            :target: https://results.pre-commit.ci/latest/github/pytask-dev/pytask/main
            :alt: pre-commit.ci status
        
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
            :target: https://github.com/psf/black
        
        
        .. end-badges
        
        
        .. start-features
        
        In its highest aspirations, pytask tries to be pytest as a build system. It's main
        purpose is to facilitate reproducible research by automating workflows in research
        projects. Its features include:
        
        - **Automatic discovery of tasks.**
        
        - **Lazy evaluation.** If a task, its dependencies, and its products have not changed,
          do not execute it.
        
        - **Debug mode.** `Jump into the debugger
          <https://pytask-dev.readthedocs.io/en/latest/tutorials/how_to_debug.html>`_ if a task
          fails, get feedback quickly, and be more productive.
        
        - **Select tasks via expressions.** Run only a subset of tasks with `expressions and
          marker expressions
          <https://pytask-dev.readthedocs.io/en/latest/tutorials/how_to_select_tasks.html>`_
          known from pytest.
        
        - **Easily extensible with plugins**. pytask's architecture is based on `pluggy
          <https://pluggy.readthedocs.io/en/latest/>`_, a plugin management framework, so that
          you can adjust pytask to your needs. Plugins are, for example, available for
          `parallelization <https://github.com/pytask-dev/pytask-parallel>`_, `LaTeX
          <https://github.com/pytask-dev/pytask-latex>`_, `R
          <https://github.com/pytask-dev/pytask-r>`_, and `Stata
          <https://github.com/pytask-dev/pytask-stata>`_. Read `here
          <https://pytask-dev.readthedocs.io/en/latest/tutorials/how_to_use_plugins.html>`_ how
          you can use plugins.
        
        .. end-features
        
        
        Installation
        ------------
        
        .. start-installation
        
        pytask is available on `PyPI <https://pypi.org/project/pytask>`_ for Python >= 3.6.1 and
        on `Anaconda.org <https://anaconda.org/conda-forge/pytask>`_ for Python >= 3.7. Install
        the package with
        
        .. code-block:: console
        
            $ pip install pytask
        
            # or
        
            $ conda install -c conda-forge pytask
        
        Color support is automatically available on non-Windows platforms. On Windows, please,
        use `Windows Terminal <https://github.com/microsoft/terminal>`_ which can be, for
        example, installed via the `Microsoft Store <https://aka.ms/terminal>`_.
        
        .. end-installation
        
        Usage
        -----
        
        A task is a function which is detected if the module and the function name are prefixed
        with ``task_``. Here is an example.
        
        .. code-block:: python
        
            # Content of task_hello.py.
        
            import pytask
        
        
            @pytask.mark.produces("hello_earth.txt")
            def task_hello_earth(produces):
                produces.write_text("Hello, earth!")
        
        Here are some details:
        
        - Dependencies and products of a task are tracked via markers. For dependencies use
          ``@pytask.mark.depends_on`` and for products use ``@pytask.mark.produces``. Use
          strings and ``pathlib.Path`` to specify the location. Pass multiple dependencies or
          products as a list.
        - With ``produces`` (and ``depends_on``) as function arguments, you get access to the
          dependencies and products inside the function via ``pathlib.Path`` objects. Here,
          ``produces`` holds the path to ``"hello_earth.txt"``.
        
        To execute the task, type the following command on the command-line
        
        .. code-block:: console
        
            $ pytask
            ========================= Start pytask session =========================
            Platform: linux -- Python 3.x.y, pytask 0.x.y, pluggy 0.x.y
            Root: xxx
            Collected 1 task(s).
        
            .
            ====================== 1 succeeded in 1 second(s) ======================
        
        
        Demo
        ----
        
        The demo walks you through the following steps.
        
        1. Write an executable script which produces a text file like you would normally do
           without pytask.
        2. Rewrite the script to a pytask task.
        3. Execute the task.
        4. Add a task which produces a second text file and another task which merges both text
           files.
        5. Execute all three tasks.
        
        .. image:: https://github.com/pytask-dev/misc/raw/main/gif/workflow.gif
        
        
        Documentation
        -------------
        
        The documentation can be found under https://pytask-dev.readthedocs.io/en/latest with
        `tutorials <https://pytask-dev.readthedocs.io/en/latest/tutorials/index.html>`_ and
        guides for `best practices
        <https://pytask-dev.readthedocs.io/en/latest/how_to_guides/index.html>`_.
        
        
        Changes
        -------
        
        Consult the `release notes <https://pytask-dev.readthedocs.io/en/latest/changes.html>`_
        to find out about what is new.
        
        
        License
        -------
        
        pytask is distributed under the terms of the `MIT license <LICENSE>`_.
        
        
        Acknowledgment
        --------------
        
        The license also includes a copyright and permission notice from pytest since some
        modules, classes, and functions are copied from pytest. Not to mention how pytest has
        inspired the development pytask in general. Without the amazing work of Holger Krekel
        and pytest's many contributors, this project would not have been possible. Thank you!
        
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.6.1
Description-Content-Type: text/x-rst
