Skip to content

Remove mentioning of absolute path to script in README.md #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tobiasraabe merged 6 commits into from
Oct 25, 2022
Merged

Remove mentioning of absolute path to script in README.md #13

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c542082
Update README.md
hmgaudecker Apr 21, 2022
c93a260
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 21, 2022
df84291
Update README.md
tobiasraabe Oct 25, 2022
29a79ab
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 25, 2022
a265257
Merge branch 'main' into hmgaudecker-patch-1
tobiasraabe Oct 25, 2022
d4910d0
Merge branch 'main' into hmgaudecker-patch-1
tobiasraabe Oct 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ or choose one of the installers on this [page](https://julialang.org/downloads/)
## Usage

To create a task which runs a Julia script, define a task function with the
`@pytask.mark.julia` decorator. The `script` keyword provides an absolute path or path
relative to the task module to the Julia script.
`@pytask.mark.julia` decorator. The `script` keyword provides a path relative to the
task module to the Julia script.

```python
import pytask
Expand Down Expand Up @@ -125,8 +125,8 @@ Julia has support for environments to execute your tasks via `Pkg.jl` which is e
pytask-julia allows you define a default environment via your
[pytask configuration file](https://pytask-dev.readthedocs.io/en/stable/tutorials/configuration.html).

Use the `julia_project` key to define an absolute path or a path relative to your
configuration file to point to your environment.
Use the `julia_project` key to define a path to your configuration file to point to your
environment.

Probably your environment files `Manifest.toml` and `Project.toml` reside at the root of
your project folder as well as your pytask configuration file. Then, the content will
Expand All @@ -138,8 +138,7 @@ julia_project = "."
```

You can also define environments for each task which will overwrite any other default
with the `project` keyword argument. Pass an absolute path or a path relative to the
task module.
with the `project` keyword argument. Pass a path to the task module.

```python
@pytask.mark.julia(script="script.jl", project=".")
Expand Down Expand Up @@ -277,10 +276,9 @@ julia_options = ["--threads", 2]

**`julia_project`**

Use this option to set a default environment for each task. Use either a path relative
to the configuration file or an absolute path. If your environment with `Manifest.toml`
and `Project.toml` is defined in the same directory as the configuration file
`pyproject.toml`, just use a dot.
Use this option to set a default environment for each task. If your environment with
`Manifest.toml` and `Project.toml` is defined in the same directory as the configuration
file `pyproject.toml`, just use a dot.

```toml
[tool.pytask.ini_options]
Expand Down