From 38235ea727a99c610d44a027ed425fa5bf66f2bb Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Wed, 15 Nov 2023 21:51:29 -0800 Subject: [PATCH] Rename package to CondaMerge --- README.md | 30 +++++++++---------- requirements_yaml.py => conda_merge.py | 0 example/README.md | 6 ++-- pyproject.toml | 10 +++---- tests/__init__.py | 2 +- ...quirements_yaml.py => test_conda_merge.py} | 4 +-- 6 files changed, 26 insertions(+), 26 deletions(-) rename requirements_yaml.py => conda_merge.py (100%) rename tests/{test_requirements_yaml.py => test_conda_merge.py} (98%) diff --git a/README.md b/README.md index a3049a54..a6794630 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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). @@ -49,7 +49,7 @@ For more options, use: - + @@ -62,7 +62,7 @@ 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. @@ -70,7 +70,7 @@ For more options, use: 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 @@ -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! 🎉👏 diff --git a/requirements_yaml.py b/conda_merge.py similarity index 100% rename from requirements_yaml.py rename to conda_merge.py diff --git a/example/README.md b/example/README.md index f73db0aa..fa20dad1 100644 --- a/example/README.md +++ b/example/README.md @@ -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. diff --git a/pyproject.toml b/pyproject.toml index 881993cb..87364c52 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 = "bas@nijho.lt" }] @@ -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 diff --git a/tests/__init__.py b/tests/__init__.py index eb1a116f..5f6d7e5f 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -1 +1 @@ -"""Tests for the ``requirements_yaml`` package.""" +"""Tests for the ``conda_merge`` package.""" diff --git a/tests/test_requirements_yaml.py b/tests/test_conda_merge.py similarity index 98% rename from tests/test_requirements_yaml.py rename to tests/test_conda_merge.py index f883c11c..6d519366 100644 --- a/tests/test_requirements_yaml.py +++ b/tests/test_conda_merge.py @@ -1,4 +1,4 @@ -"""requirements_yaml tests.""" +"""conda_merge tests.""" from __future__ import annotations from typing import TYPE_CHECKING @@ -6,7 +6,7 @@ import pytest import yaml -from requirements_yaml import ( +from conda_merge import ( generate_conda_env_file, parse_requirements, scan_requirements,