conda-join 0.1.0

Unified Conda and Pip requirements management.

: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 is environment.yaml).

For more options, use:

</code></pre>
<!-- OUTPUT:END -->
<h2>:wrench: Advanced Configuration</h2>
<p><code>conda_join</code> allows advanced configurations such as verbose output and printing to <code>stdout</code> instead of a file.</p>
<ul>
<li>To enable verbose output, use the <code>-v</code> or <code>--verbose</code> flag.</li>
<li>To print the combined environment to <code>stdout</code> instead of saving to a file, use the <code>--stdout</code> flag.</li>
</ul>
<p>Example with advanced options:</p>
<pre lang="bash"><code>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 scanned requirements.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 multiple requirements.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! 🎉👏