Skip to content

Commit

Permalink
docs: Mention required openssl dep for rust-script (#1216)
Browse files Browse the repository at this point in the history
* docs: Add OpenSSL, C compiler deps for rust-script

OpenSSL is added indirectly via dependencies pulled in from the
json_typegen=0.7 Crate. The compilation needs OpenSSL sources from the
conda-forge::openssl package and a C compiler that uses the Conda
prefix's path to look for headers/libraries which is provided via
conda-forge::c-compiler.

* chore: Fix test_conda: check python<3.10 output

Help text output changed with Python 3.10 due to renamed optionals
group; ref: https://github.com/python/cpython/pull/23858/files
  • Loading branch information
mbargull committed Oct 20, 2021
1 parent b3c4e68 commit fc8c5f6
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/snakefiles/rules.rst
Expand Up @@ -744,10 +744,11 @@ Rust_
script:
"path/to/script.rs"
The ability to execute Rust scripts is facilitated by |rust-script|_. As such, the
script must be a valid ``rust-script`` script and ``rust-script`` must be available in the
environment the rule is run in.
The minimum required ``rust-script`` version is `1.15.0`, so in the example above, the contents of ``rust.yaml`` might look like this:
The ability to execute Rust scripts is facilitated by |rust-script|_.
As such, the script must be a valid ``rust-script`` script and ``rust-script``
(plus OpenSSL and a C compiler toolchain, provided by Conda packages ``openssl``, ``c-compiler``, ``pkg-config``)
must be available in the environment the rule is run in.
The minimum required ``rust-script`` version is 1.15.0, so in the example above, the contents of ``rust.yaml`` might look like this:

.. code block:: yaml
Expand All @@ -756,6 +757,9 @@ The minimum required ``rust-script`` version is `1.15.0`, so in the example abov
- bioconda
dependencies:
- rust-script>=0.15.0
- openssl
- c-compiler
- pkg-config
Expand Down
1 change: 1 addition & 0 deletions tests/test_conda/test-env.yaml
Expand Up @@ -3,3 +3,4 @@ channels:
- conda-forge
dependencies:
- melt ==1.0.3
- python <3.10
3 changes: 3 additions & 0 deletions tests/test_script/envs/rust.yaml
Expand Up @@ -3,3 +3,6 @@ channels:
- bioconda
dependencies:
- rust-script>=0.15.0
- openssl
- c-compiler
- pkg-config

0 comments on commit fc8c5f6

Please sign in to comment.