Release 0.0.5 and better tasks ids and selection of tasks. (#15)

Author: tobiasraabe

.conda/meta.yaml

@@ -13,7 +13,7 @@ build:
   noarch: python
   number: 0
   entry_points:
-    - pytask = pytask.cli:pytask
+    - pytask = _pytask.cli:pytask
 
 requirements:
   host:

docs/api.rst

@@ -0,0 +1,12 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+   :titlesonly:
+
+   /autoapi/pytask/index
+   /autoapi/_pytask/index
+
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

docs/changes.rst

@@ -6,13 +6,15 @@ chronological order. Releases follow `semantic versioning <https://semver.org/>`
 all releases are available on `Anaconda.org <https://anaconda.org/pytask/pytask>`_.
 
 
-0.0.5 - 2020-xx-xx
+0.0.5 - 2020-08-12
 ------------------
 
 - :gh:`10` turns parametrization into a plugin.
 - :gh:`11` extends the documentation.
 - :gh:`12` replaces ``pytest.mark`` with ``pytask.mark``.
 - :gh:`13` implements selecting tasks via expressions or marker expressions.
+- :gh:`14` separates the namespace of pytask to ``pytask`` and ``_pytask``.
+- :gh:`15` implements better tasks ids which allow and releases 0.0.5.
 
 
 0.0.4 - 2020-07-22

docs/conf.py

@@ -19,7 +19,7 @@
 author = "Tobias Raabe"
 
 # The full version, including alpha/beta/rc tags
-release = "0.0.4"
+release = "0.0.5"
 
 
 # -- General configuration -------------------------------------------------------------
@@ -51,6 +51,8 @@
 # html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+suppress_warnings = ["ref.python"]
+
 # -- Extensions configuration ----------------------------------------------------------
 
 # Configuration for autodoc
@@ -74,8 +76,9 @@
 
 # Configuration for autoapi
 autoapi_type = "python"
-autoapi_dirs = ["../src/pytask"]
+autoapi_dirs = ["../src"]
 autoapi_keep_files = False
+autoapi_add_toctree_entry = False
 
 
 # -- Options for HTML output -----------------------------------------------------------

docs/index.rst

@@ -119,3 +119,4 @@ The documentation has currently one of four planned parts.
 
    glossary
    changes
+   api

docs/reference_guides/hookspecs.rst

@@ -1,7 +1,7 @@
 Hook Specifications
 ===================
 
-.. currentmodule:: pytask.hookspecs
+.. currentmodule:: _pytask.hookspecs
 
 Hook specifications are the :term:`entry-points <entry-point>` provided by pytask to
 change the behavior of the program.

docs/reference_guides/marks.rst

@@ -8,19 +8,19 @@ in the host or in plugins. The following marks are available by default.
 pytask.mark.depends_on
 ----------------------
 
-.. autofunction:: pytask.nodes.depends_on
+.. autofunction:: _pytask.nodes.depends_on
    :noindex:
 
 
 pytask.mark.produces
 --------------------
 
-.. autofunction:: pytask.nodes.produces
+.. autofunction:: _pytask.nodes.produces
    :noindex:
 
 
 pytask.mark.parametrize
 -----------------------
 
-.. autofunction:: pytask.parametrize.parametrize
+.. autofunction:: _pytask.parametrize.parametrize
    :noindex:

docs/tutorials/how_to_configure_pytask.rst

@@ -47,3 +47,29 @@ configuration file.
 
     markers =
         wip: Work-in-progress. These are tasks which I am currently working on.
+
+
+ignore
+------
+
+pytask can ignore files and directories and exclude some tasks or reduce the duration of
+the collection.
+
+To ignore some file/folder via the command line, use the ``--ignore`` flag multiple
+times.
+
+.. code-block:: bash
+
+    $ pytask --ignore */some_file.py --ignore */some_directory/*
+
+Or, use the configuration file:
+
+.. code-block:: ini
+
+    # For single entries only.
+    ignore = */some_file.py
+
+    # Or single and multiple entries.
+    ignore =
+        */some_directory/*
+        */some_file.py

docs/tutorials/how_to_select_tasks.rst

@@ -79,3 +79,9 @@ will execute the first and third task and
     $ pytask -k "1 and not 2"
 
 executes only the first task.
+
+To execute a single task, say ``task_run_this_one``, in ``task_example.py``, use
+
+.. code-block:: bash
+
+    $ pytask -k task_example.py::task_run_this_one

setup.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
-current_version = 0.0.4
+current_version = 0.0.5
 parse = (?P<major>\d+)\.(?P<minor>\d+)(\.(?P<patch>\d+))(\-?((dev)?(?P<dev>\d+))?)
-serialize =
+serialize = 
 	{major}.{minor}.{patch}dev{dev}
 	{major}.{minor}.{patch}