Most tests working.

Author: hmgaudecker

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,18 +1,18 @@
 ---
 
 name: Bug Report
-about: Create a bug report to help us improve pytask-xxxxx
+about: Create a bug report to help us improve pytask-julia
 title: "BUG:"
 labels: "bug"
 
 ---
 
 - [ ] I have checked that this issue has not already been reported.
 
-- [ ] I have confirmed this bug exists on the latest version of pytask-xxxxx.
+- [ ] I have confirmed this bug exists on the latest version of pytask-julia.
 
 - [ ] (optional) I have confirmed this bug exists on the `main` branch of
-  pytask-xxxxx.
+  pytask-julia.
 
 ---
 

.github/ISSUE_TEMPLATE/documentation.md

@@ -12,7 +12,7 @@ labels: "documentation"
 Provide the location of the documentation, e.g. an URL of the documentation.
 
 **Note**: You can check the latest versions of the docs on `main`
-[here](https://pytask-xxxxx.readthedocs.io/en/latest).
+[here](https://pytask-julia.readthedocs.io/en/latest).
 
 #### Documentation problem
 

.github/ISSUE_TEMPLATE/enhancement.md

@@ -1,15 +1,15 @@
 ---
 
 name: Enhancement
-about: Suggest an idea for pytask-xxxxx
+about: Suggest an idea for pytask-julia
 title: "ENH:"
 labels: "enhancement"
 
 ---
 
 #### Is your feature request related to a problem?
 
-Provide a description of what the problem is, e.g. "I wish I could use pytask-xxxxx
+Provide a description of what the problem is, e.g. "I wish I could use pytask-julia
 to do [...]".
 
 #### Describe the solution you'd like

.github/ISSUE_TEMPLATE/question.md

@@ -1,13 +1,13 @@
 ---
 
 name: Submit Question
-about: Ask a general question about pytask-xxxxx
+about: Ask a general question about pytask-script.jl
 title: "QST:"
 labels: "question"
 
 ---
 
-#### Question about pytask-xxxxx
+#### Question about pytask-script.jl
 
 **Note**: If you'd still like to submit a question, please read [this guide](
 https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to

.github/workflows/main.yml

@@ -11,21 +11,18 @@ jobs:
 
   run-tests:
 
-    name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }} and ${{ matrix.xxxxx-version }}
+    name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }} and ${{ matrix.julia-version }}
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
         os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
         python-version: ['3.7', '3.8', '3.9']
-        xxxxx-version: ['main_version']
+        julia-version: ['main_version']
 
     steps:
       - uses: actions/checkout@v2
-      - uses: xxxxx-lib/actions/setup-r@v1
-        with:
-          r-version: ${{ matrix.xxxxx-version }}
       - uses: conda-incubator/setup-miniconda@v2
         with:
           auto-update-conda: true
@@ -42,7 +39,7 @@ jobs:
         run: tox -e pytest -- -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto
 
       - name: Upload coverage report for unit tests and doctests.
-        if: runner.os == 'Linux' && matrix.python-version == '3.8' && matrix.xxxxx-version == 'main_version'
+        if: runner.os == 'Linux' && matrix.python-version == '3.8' && matrix.julia-version == 'main_version'
         shell: bash -l {0}
         run: bash <(curl -s https://codecov.io/bash) -F unit -c
 
@@ -51,11 +48,11 @@ jobs:
         run: tox -e pytest -- -m end_to_end --cov=./ --cov-report=xml -n auto
 
       - name: Upload coverage reports of end-to-end tests.
-        if: runner.os == 'Linux' && matrix.python-version == '3.8' && matrix.xxxxx-version == 'main_version'
+        if: runner.os == 'Linux' && matrix.python-version == '3.8' && matrix.julia-version == 'main_version'
         shell: bash -l {0}
         run: bash <(curl -s https://codecov.io/bash) -F end_to_end -c
 
       - name: Validate codecov.yml
-        if: runner.os == 'Linux' && matrix.python-version == '3.8' && matrix.xxxxx-version == 'main_version'
+        if: runner.os == 'Linux' && matrix.python-version == '3.8' && matrix.julia-version == 'main_version'
         shell: bash -l {0}
         run: cat codecov.yml | curl --data-binary @- https://codecov.io/validate

README.rst

@@ -1,28 +1,3 @@
-# Template for pytask plugins
-
-This template has been generated by comparing the R and Stata plugins. It is thus based on the assumption that anything which is common between those two plugins is likely to be the same in the new plugin as well.
-
-Usage:
-- Download the source code
-- Rename the folder `src/pytask_xxxxx` to `src/pytask_[your plugin's identifier]`
-- Open this entire source code in an editor.
-- Do project wide search (S) and replace for:
-
-  - **S**: YYYYY, **R**: [Your language's verbose name, e.g. R, Stata, Julia]
-  - **S**: ZZZZZ, **R**: [The command to start your program, e.g. RScript] *(if not common across platforms or more complicated, see the Stata plugin for more involved handling)*
-  - **S**: pytask-xxxxx, **R**: pytask-[your plugin's identifier]
-  - **S**: pytask_xxxxx, **R**: pytask_[your plugin's identifier]
-  - **S**: xxxxx, **R** on a case-by-case basis. This will often be your plugin's identifier, but can also be the extension of scripts in your language (e.g., `r`, `do`, `jl`) or other things.
-
-- Try out
-- Likely the first necessary adjustments will be to the code in collect.py
-- For sure, later adjustments will be necessary for
-  - the code snippets in the tests and README.rst
-  - the author name and e-mail in `setup.cfg`
-- Please let us know any things you think are worth noting!
-
-------
-
 pytask-julia
 ============
 
@@ -71,106 +46,106 @@ pytask-julia is available on `PyPI <https://pypi.org/project/pytask-julia>`_ and
 
     $ conda install -c conda-forge pytask-julia
 
-You also need to have YYYYY installed and ``ZZZZZ`` on your command line. Test it by
+You also need to have Julia installed and ``julia`` on your command line. Test it by
 typing the following on the command line
 
 .. code-block:: console
 
-    $ ZZZZZ --help
+    $ julia -h
 
-If an error is shown instead of a help page, you can install YYYYY ....
+If an error is shown instead of a help page, you can install Julia ....
 
 
 Usage
 -----
 
 Similarly to normal task functions which execute Python code, you define tasks to
-execute scripts written in YYYYY with Python functions. The difference is that the
+execute scripts written in Julia with Python functions. The difference is that the
 function body does not contain any logic, but the decorator tells pytask how to handle
 the task.
 
-Here is an example where you want to run ``script.xxxxx``.
+Here is an example where you want to run ``script.julia``.
 
 .. code-block:: python
 
     import pytask
 
 
-    @pytask.mark.xxxxx
-    @pytask.mark.depends_on("script.xxxxxx")
+    @pytask.mark.julia
+    @pytask.mark.depends_on("script.jl")
     @pytask.mark.produces("out.csv")
-    def task_run_xxxxx_script():
+    def task_run_jl_script():
         pass
 
-Note that, you need to apply the ``@pytask.mark.xxxxx`` marker so that pytask-xxxxx handles the
+Note that, you need to apply the ``@pytask.mark.julia`` marker so that pytask-julia handles the
 task.
 
-If you are wondering why the function body is empty, know that pytask-xxxxx replaces the
+If you are wondering why the function body is empty, know that pytask-julia replaces the
 body with a predefined internal function. See the section on implementation details for
 more information.
 
 
 Multiple dependencies and products
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-What happens if a task has more dependencies? Using a list, the YYYYY script which should be
+What happens if a task has more dependencies? Using a list, the Julia script which should be
 executed must be found in the first position of the list.
 
 .. code-block:: python
 
-    @pytask.mark.xxxxx
-    @pytask.mark.depends_on(["script.xxxxx", "input.csv"])
+    @pytask.mark.julia
+    @pytask.mark.depends_on(["script.jl", "input.csv"])
     @pytask.mark.produces("out.csv")
-    def task_run_xxxxx_script():
+    def task_run_jl_script():
         pass
 
-If you use a dictionary to pass dependencies to the task, pytask-xxxxx will, first, look
+If you use a dictionary to pass dependencies to the task, pytask-julia will, first, look
 for a ``"source"`` key in the dictionary and, secondly, under the key ``0``.
 
 .. code-block:: python
 
-    @pytask.mark.xxxxx
-    @pytask.mark.depends_on({"source": "script.xxxxx", "input": "input.csv"})
-    def task_run_xxxxx_script():
+    @pytask.mark.julia
+    @pytask.mark.depends_on({"source": "script.jl", "input": "input.csv"})
+    def task_run_jl_script():
         pass
 
 
     # or
 
 
-    @pytask.mark.xxxxx
-    @pytask.mark.depends_on({0: "script.xxxxx", "input": "input.csv"})
-    def task_run_xxxxx_script():
+    @pytask.mark.julia
+    @pytask.mark.depends_on({0: "script.jl", "input": "input.csv"})
+    def task_run_jl_script():
         pass
 
 
     # or two decorators for the function, if you do not assign a name to the input.
 
 
-    @pytask.mark.xxxxx
-    @pytask.mark.depends_on({"source": "script.xxxxx"})
+    @pytask.mark.julia
+    @pytask.mark.depends_on({"source": "script.jl"})
     @pytask.mark.depends_on("input.csv")
-    def task_run_xxxxx_script():
+    def task_run_jl_script():
         pass
 
 
 Command Line Arguments
 ~~~~~~~~~~~~~~~~~~~~~~
 
-The decorator can be used to pass command line arguments to ``ZZZZZ``. See the
+The decorator can be used to pass command line arguments to ``julia``. See the
 following example.
 
 .. code-block:: python
 
-    @pytask.mark.xxxxx("value")
-    @pytask.mark.depends_on("script.xxxxx")
+    @pytask.mark.julia("value")
+    @pytask.mark.depends_on("script.jl")
     @pytask.mark.produces("out.csv")
-    def task_run_xxxxx_script():
+    def task_run_jl_script():
         pass
 
-And in your ``script.xxxxx``, you can intercept the value with
+And in your ``script.jl``, you can intercept the value with
 
-.. code-block:: YYYYY
+.. code-block:: Julia
 
     FIXME FOR YOUR LANGUAGE
     args <- commandArgs(trailingOnly=TRUE)
@@ -180,22 +155,22 @@ And in your ``script.xxxxx``, you can intercept the value with
 Parametrization
 ~~~~~~~~~~~~~~~
 
-You can also parametrize the execution of scripts, meaning executing multiple YYYYY scripts
-as well as passing different command line arguments to the same YYYYY script.
+You can also parametrize the execution of scripts, meaning executing multiple Julia scripts
+as well as passing different command line arguments to the same Julia script.
 
-The following task executes two YYYYY scripts which produce different outputs.
+The following task executes two Julia scripts which produce different outputs.
 
 .. code-block:: python
 
     from src.config import BLD, SRC
 
 
-    @pytask.mark.xxxxx
+    @pytask.mark.julia
     @pytask.mark.parametrize(
         "depends_on, produces",
-        [(SRC / "script_1.xxxxx", BLD / "1.csv"), (SRC / "script_2.xxxxx", BLD / "2.csv")],
+        [(SRC / "script_1.jl", BLD / "1.csv"), (SRC / "script_2.jl", BLD / "2.csv")],
     )
-    def task_execute_xxxxx_script():
+    def task_execute_julia_script():
         pass
 
 And the R script includes something like
@@ -205,30 +180,30 @@ And the R script includes something like
     args <- commandArgs(trailingOnly=TRUE)
     produces <- args[1]  # holds the path
 
-If you want to pass different command line arguments to the same YYYYY script, you have to
-include the ``@pytask.mark.xxxxx`` decorator in the parametrization just like with
+If you want to pass different command line arguments to the same Julia script, you have to
+include the ``@pytask.mark.julia`` decorator in the parametrization just like with
 ``@pytask.mark.depends_on`` and ``@pytask.mark.produces``.
 
 .. code-block:: python
 
-    @pytask.mark.depends_on("script.xxxxx")
+    @pytask.mark.depends_on("script.jl")
     @pytask.mark.parametrize(
-        "produces, xxxxx",
+        "produces, julia",
         [(BLD / "output_1.csv", "1"), (BLD / "output_2.csv", "2")],
     )
-    def task_execute_xxxxx_script():
+    def task_execute_julia_script():
         pass
 
 
 Configuration
 -------------
 
-If you want to change the name of the key which identifies the YYYYY script, change the
+If you want to change the name of the key which identifies the Julia script, change the
 following default configuration in your pytask configuration file.
 
 .. code-block:: ini
 
-    xxxxx_source_key = source
+    julia_source_key = source
 
 
 Implementation Details
@@ -240,12 +215,12 @@ The plugin is a convenient wrapper around
 
     import subprocess
 
-    subprocess.run(["ZZZZZ", "script.xxxxx"], check=True)
+    subprocess.run(["julia", "script.jl"], check=True)
 
 to which you can always resort to when the plugin does not deliver functionality you
 need.
 
-It is not possible to enter a post-mortem debugger when an error happens in the YYYYY script
+It is not possible to enter a post-mortem debugger when an error happens in the Julia script
 or enter the debugger when starting the script. If there exists a solution for that,
 hints as well as contributions are highly appreciated.
 

environment.yml

@@ -5,6 +5,7 @@ channels:
   - nodefaults
 
 dependencies:
+  - julia
   - python
   - pip
   - setuptools_scm