Metadata-Version: 2.1
Name: conda_recipe_manager
Version: 0.3.4
Summary: Fast and rough renderer of conda recipes.
Author-email: "Anaconda, Inc." <distribution_team@anaconda.com>
License: BSD 3-Clause License
        
        Copyright (c) 2024, Anaconda, Inc
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/anaconda/conda-recipe-manager
Project-URL: Bug Tracker, https://github.com/anaconda/conda-recipe-manager/issues
Project-URL: Repository, https://github.com/anaconda/conda-recipe-manager
Project-URL: Documentation, https://github.com/anaconda/conda-recipe-manager/blob/main/README.md
Keywords: renderer,conda recipe
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: jinja2
Requires-Dist: pyyaml
Requires-Dist: jsonschema
Requires-Dist: requests
Requires-Dist: gitpython
Requires-Dist: networkx
Requires-Dist: matplotlib
Requires-Dist: pygraphviz
Provides-Extra: conda_build
Requires-Dist: conda-build; extra == "conda-build"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"

[commit-checks-badge]: https://github.com/conda-incubator/conda-recipe-manager/actions/workflows/commit_checks.yaml/badge.svg?branch=main
[integration-tests-badge]: https://github.com/conda-incubator/conda-recipe-manager/actions/workflows/integration_tests.yaml/badge.svg?branch=main
[release-badge]: https://img.shields.io/github/v/release/conda-incubator/conda-recipe-manager?logo=github


# conda-recipe-manager

[![Commit Checks][commit-checks-badge]](https://github.com/conda-incubator/conda-recipe-manager/actions/workflows/commit_checks.yaml)
[![Integration Tests][integration-tests-badge]](https://github.com/conda-incubator/conda-recipe-manager/actions/workflows/integration_tests.yaml)
[![GitHub Release][release-badge]](https://github.com/conda-incubator/conda-recipe-manager/releases)

## Table of Contents
<!-- TOC -->

- [conda-recipe-manager](#conda-recipe-manager)
    - [Table of Contents](#table-of-contents)
- [Overview](#overview)
    - [History](#history)
- [Getting Started](#getting-started)
    - [General Installation](#general-installation)
        - [Install into your current environment](#install-into-your-current-environment)
        - [Install into a custom environment](#install-into-a-custom-environment)
- [Developer Notes](#developer-notes)
        - [Running pre-commit checks](#running-pre-commit-checks)
    - [Release process](#release-process)
- [Special Thanks](#special-thanks)

<!-- /TOC -->
# Overview
Conda Recipe Manager (CRM) is a library and tool set capable of parsing Conda recipe files. It is intended to be
used by package builders and developers to automate the generation and editing of Conda recipe files.

Currently only recipe files in the V0 format are supported, but there is some on-going work to add full support for
V1-formatted files.

Library documentation can be found [here](https://conda-incubator.github.io/conda-recipe-manager/index.html).

## History
This project started out as a recipe parsing library in Anaconda's
[percy](https://github.com/anaconda-distribution/percy) project.

# Getting Started

## General Installation

### Install into your current environment
```sh
make install
```

### Install into a custom environment
```sh
make environment
conda activate conda-recipe-manager
```

# Developer Notes
```sh
make dev
conda activate conda-recipe-manager
```
The `dev` recipe will configure a `conda` environment named `conda-recipe-manager` with
development tools installed.

`pre-commit` is automatically installed and configured for you to run a number
of automated checks on each commit.

**NOTE:** As of writing, only a handful of files are checked by the linter and
`pre-commit`. **ANY NEW FILES** should be added to these checks.

### Running pre-commit checks
The provided `Makefile` also provides a handful of convenience recipes for
running all or part of the `pre-commit` automations:
1. `make test`: Runs all the unit tests
1. `make test-cov`: Reports the current test coverage percentage and indicates
   which lines are currently untested.
1. `make lint`: Runs our `pylint` configuration, based on Google's Python
   standards.
1. `make format`: Automatically formats code
1. `make analyze`: Runs the static analyzer, `mypy`.
1. `make pre-commit`: Runs all the `pre-commit` checks

## Release process
1. Update `CHANGELOG.md`
1. Update the version number in `pyproject.toml`, `docs/conf.py`, and `recipe/meta.yaml`
1. Ensure `environment.yaml` is up to date with the latest dependencies
1. Create a new release on GitHub with a version tag.
1. Manage the conda-forge feedstock, as per [this doc](https://conda-forge.org/docs/maintainer/adding_pkgs/)

# Special Thanks
- @cbouss for his work on the [Percy project](https://github.com/anaconda/percy) that originally inspired the recipe parser.
- @akabanovs for his work and experimentation on package dependency graph building.
- @JeanChristopheMorinPerso for his PR review contributions when this project was a part of `Percy` and answering questions about the `conda` file formats.
