Unified Conda and Pip requirements management.
Project description
:rocket: conda-join
- Unified Conda and Pip Requirements Management :rocket:
conda_join
is a Python package designed to streamline the management and combination of multiple requirements.yaml
files into a single Conda environment.yaml
. This tool is ideal for projects with multiple subcomponents, each having its own dependencies, simplifying the process of creating a unified Conda environment. 🖥️🔥
:books: Table of Contents
- :package: Installation
- :memo: Usage
- :wrench: Advanced Configuration
- :scroll: Output Options
- :warning: Limitations
:package: Installation
To install conda_join
, run the following command:
pip install -U conda_join
Or just copy the script to your computer:
wget https://raw.githubusercontent.com/basnijholt/requirements.yaml/main/conda_join.py
:memo: Usage
After installation, you can use conda_join
to scan directories for requirements.yaml
files and combine them into an environment.yaml
file. Basic usage is as follows:
conda_join -d [DIRECTORY] --depth [DEPTH] -o [OUTPUT_FILE]
-d
or--directory
: Specify the base directory to scan (default is current directory).--depth
: Specify the depth for scanning subdirectories (default is 1).-o
or--output
: Specify the output file for the combined environment (default isenvironment.yaml
).
For more options, use:
usage: conda-join [-h] [-d DIRECTORY] [--depth DEPTH] [-o OUTPUT] [-v]
[--stdout]
Unified Conda and Pip requirements management.
options:
-h, --help show this help message and exit
-d DIRECTORY, --directory DIRECTORY
Base directory to scan for requirements.yaml files, by
default `.`
--depth DEPTH Depth to scan for requirements.yaml files, by default
1
-o OUTPUT, --output OUTPUT
Output file for the conda environment, by default
`environment.yaml`
-v, --verbose Print verbose output
--stdout Output to stdout instead of a file
:wrench: Advanced Configuration
conda_join
allows advanced configurations such as verbose output and printing to stdout
instead of a file.
- To enable verbose output, use the
-v
or--verbose
flag. - To print the combined environment to
stdout
instead of saving to a file, use the--stdout
flag.
Example with advanced options:
conda_join -d src --depth 2 -o dev_environment.yaml --verbose
:scroll: Output Options
- The output
environment.yaml
file will contain a unified list of dependencies from all scannedrequirements.yaml
files. - If the
--stdout
flag is used, the combined environment will be printed to the console.
:warning: Limitations
- The current version of
conda_join
does not support conflict resolution between different versions of the same package in multiplerequirements.yaml
files. - Designed primarily for use with Conda environments; may not fully support other package management systems.
Try conda_join
today for a streamlined approach to managing your Conda environment dependencies across multiple projects! 🎉👏
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for conda_join-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 374fd0c58912c9e5ee392366dda88665d8888935c201529cea765476a3ca0fa9 |
|
MD5 | 353d22ca210d3fe4f9e582b8c8fcd4b5 |
|
BLAKE2b-256 | a50161b6789e238c03e589a75c5f815bb270dd2b3caf3bcc14164f17c756f067 |