Skip to content

Commit

Permalink
Rename package to CondaMerge
Browse files Browse the repository at this point in the history
  • Loading branch information
basnijholt committed Nov 16, 2023
1 parent 0c16c51 commit 38235ea
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 26 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# :rocket: requirements_yaml - Unified Conda and Pip Requirements Management :rocket:
# :rocket: CondaMerge - Unified Conda and Pip Requirements Management :rocket:

[![PyPI](https://img.shields.io/pypi/v/requirements_yaml.svg)](https://pypi.python.org/pypi/requirements_yaml)
[![Build Status](https://github.com/basnijholt/requirements_yaml/actions/workflows/pytest.yml/badge.svg)](https://github.com/basnijholt/requirements_yaml/actions/workflows/pytest.yml)
[![CodeCov](https://codecov.io/gh/basnijholt/requirements_yaml/branch/main/graph/badge.svg)](https://codecov.io/gh/basnijholt/requirements_yaml)
[![PyPI](https://img.shields.io/pypi/v/conda_merge.svg)](https://pypi.python.org/pypi/conda_merge)
[![Build Status](https://github.com/basnijholt/conda_merge/actions/workflows/pytest.yml/badge.svg)](https://github.com/basnijholt/conda_merge/actions/workflows/pytest.yml)
[![CodeCov](https://codecov.io/gh/basnijholt/conda_merge/branch/main/graph/badge.svg)](https://codecov.io/gh/basnijholt/conda_merge)

`requirements_yaml` 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. 🖥️🔥
`conda_merge` 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

Expand All @@ -22,23 +22,23 @@

## :package: Installation

To install `requirements_yaml`, run the following command:
To install `conda_merge`, run the following command:

```bash
pip install -U requirements_yaml
pip install -U conda_merge
```

Or just copy the script to your computer:
```bash
wget https://raw.githubusercontent.com/basnijholt/requirements.yaml/main/requirements_yaml.py
wget https://raw.githubusercontent.com/basnijholt/requirements.yaml/main/conda_merge.py
```

## :memo: Usage

After installation, you can use `requirements_yaml` to scan directories for `requirements.yaml` files and combine them into an `environment.yaml` file. Basic usage is as follows:
After installation, you can use `conda_merge` to scan directories for `requirements.yaml` files and combine them into an `environment.yaml` file. Basic usage is as follows:

```bash
requirements_yaml -d [DIRECTORY] --depth [DEPTH] -o [OUTPUT_FILE]
conda_merge -d [DIRECTORY] --depth [DEPTH] -o [OUTPUT_FILE]
```

- `-d` or `--directory`: Specify the base directory to scan (default is current directory).
Expand All @@ -49,7 +49,7 @@ For more options, use:

<!-- CODE:BASH:START -->
<!-- echo '```bash' -->
<!-- requirements_yaml -h -->
<!-- conda_merge -h -->
<!-- echo '```' -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
Expand All @@ -62,15 +62,15 @@ For more options, use:

## :wrench: Advanced Configuration

`requirements_yaml` allows advanced configurations such as verbose output and printing to `stdout` instead of a file.
`conda_merge` 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:

```bash
requirements_yaml -d src --depth 2 -o dev_environment.yaml --verbose
conda_merge -d src --depth 2 -o dev_environment.yaml --verbose
```

## :scroll: Output Options
Expand All @@ -80,9 +80,9 @@ requirements_yaml -d src --depth 2 -o dev_environment.yaml --verbose

## :warning: Limitations

- The current version of `requirements_yaml` does not support conflict resolution between different versions of the same package in multiple `requirements.yaml` files.
- The current version of `conda_merge` 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 `requirements_yaml` today for a streamlined approach to managing your Conda environment dependencies across multiple projects! 🎉👏
Try `conda_merge` today for a streamlined approach to managing your Conda environment dependencies across multiple projects! 🎉👏
File renamed without changes.
6 changes: 3 additions & 3 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

Run `requirements.yaml` files in subdirectories and combine them into an `environment.yaml` file.

Here we can just run `requirements_yaml` with no arguments, since the defaults are the same as what we want.
Here we can just run `conda_merge` with no arguments, since the defaults are the same as what we want.

This would be the same as running:

```bash
requirements_yaml --directory . --depth 1 --output environment.yaml
conda_merge --directory . --depth 1 --output environment.yaml
```
or
```bash
requirements_yaml -d . --depth 1 -o environment.yaml
conda_merge -d . --depth 1 -o environment.yaml
```

See the resulting [`environment.yaml`](environment.yaml) file.
10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "requirements_yaml"
name = "conda_merge"
description = "Unified Conda and Pip requirements management."
version = "0.1.0"
authors = [{ name = "Bas Nijholt", email = "[email protected]" }]
Expand All @@ -15,20 +15,20 @@ file = "README.md"
content-type = "text/markdown"

[project.urls]
Homepage = "https://github.com/basnijholt/requirements_yaml"
Homepage = "https://github.com/basnijholt/conda_merge"

[project.optional-dependencies]
test = ["pytest", "pre-commit", "coverage", "pytest-cov", "pytest-mock"]

[project.scripts]
requirements_yaml = "requirements_yaml:main"
conda_merge = "conda_merge:main"

[tool.setuptools]
py-modules = ["requirements_yaml"]
py-modules = ["conda_merge"]

[tool.pytest.ini_options]
addopts = """
--cov=requirements_yaml
--cov=conda_merge
--cov-report term
--cov-report html
--cov-fail-under=70
Expand Down
2 changes: 1 addition & 1 deletion tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"""Tests for the ``requirements_yaml`` package."""
"""Tests for the ``conda_merge`` package."""
4 changes: 2 additions & 2 deletions tests/test_requirements_yaml.py → tests/test_conda_merge.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
"""requirements_yaml tests."""
"""conda_merge tests."""
from __future__ import annotations

from typing import TYPE_CHECKING

import pytest
import yaml

from requirements_yaml import (
from conda_merge import (
generate_conda_env_file,
parse_requirements,
scan_requirements,
Expand Down

0 comments on commit 38235ea

Please sign in to comment.