Metadata-Version: 2.1
Name: percy
Version: 0.1.0
Summary: Fast and rough renderer of conda recipes.
Author-email: "Anaconda, Inc." <distribution_team@anaconda.com>
License: BSD 3-Clause License
        
        Copyright (c) 2022, Anaconda, Inc.
        All rights reserved.
        
        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-distribution/percy
Project-URL: Bug Tracker, https://github.com/anaconda-distribution/percy/issues
Project-URL: Repository, https://github.com/anaconda-distribution/percy
Project-URL: Documentation, https://github.com/anaconda-distribution/percy/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
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
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.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: jinja2
Requires-Dist: pyyaml
Requires-Dist: requests
Requires-Dist: jsonschema
Provides-Extra: conda_build
Requires-Dist: conda-build ; extra == 'conda_build'
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: ruamel.yaml ; extra == 'dev'
Provides-Extra: ruamel
Requires-Dist: ruamel.yaml ; extra == 'ruamel'

# Percy

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

- [Percy](#percy)
    - [Table of Contents](#table-of-contents)
    - [Overview](#overview)
- [Getting Started](#getting-started)
    - [General Installation](#general-installation)
        - [Install into your current environment](#install-into-your-current-environment)
        - [Install into a custom percy environment](#install-into-a-custom-percy-environment)
- [Developer Installation](#developer-installation)
        - [Running pre-commit checks](#running-pre-commit-checks)
    - [Command line examples](#command-line-examples)
    - [Other examples](#other-examples)
        - [Recipe patching](#recipe-patching)
        - [Python 3.11 buildout](#python-311-buildout)
        - [Build order examples](#build-order-examples)
        - [Test install examples](#test-install-examples)
        - [Find pinning issues in aggregate](#find-pinning-issues-in-aggregate)

<!-- /TOC -->
## Overview

This library is able to render recipes for all variants (subdir, python... combination).
When given a directory of feedstocks (aggregate), it can produce a rough build order.
It can be used as a command line tool but is mostly intended to be used as a library.

Why not using conda build to render?
conda build resolves dependencies to qualify versions and process run_exports and other keys.
This library renders without querying a channel, and is more suited for development phase.

# Getting Started

## General Installation

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

### Install into a custom percy environment
```sh
make environment
conda activate percy
```

# Developer Installation
```sh
make dev
conda activate percy
```
The `dev` recipe will configure a `conda` environment named `percy` 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

## Command line examples

From within a feedstock:

  percy recipe --help

- Render the recipe

        percy recipe render --help
        percy recipe render -s linux-64 -p 3.10 -k blas_impl openblas

- Identify if the feedstock is pinned to the latest, compared to defautls:

        percy recipe outdated --help
        percy recipe outdated

From within aggregate:

Queries can be performed on feedstock names (-f), package names (-pkg) and group names (-g).
A group name corresponds to the github/gitlab... organization name, extracted from dev_url.

  percy aggregate --help

- When updating a package pinned in cbc, show rebuild order:

        percy aggregate downstream --help
        percy aggregate downstream -f libxml2-feedstock

- When working on a group of packages, show build order:

        percy aggregate order --help
        percy aggregate order -f dask-feedstock -f dask-core-feedstock -f distributed-feedstock
        percy aggregate order -g dask

- When building from scratch, show what to build based on leaf packages:

        percy aggregate upstream --help
        percy aggregate upstream -f pytorch-feedstock

- Identify which feedstocks are not pinned to the latest, compared to defautls:

        percy aggregate outdated --help
        percy aggregate outdated

## Other examples

### Recipe patching

See percy/examples/patch

### Python 3.11 buildout

See percy/examples/py311 [here](percy/examples/py311/README.md)

### Build order examples

See percy/examples/blts

### Test install examples

  pytest -n auto --junit-xml="test_install.xml" --html="test_install.html" --self-contained-html ./percy/examples/preinstall/test_install.py --feedstock=./gensim-feedstock


### Find pinning issues in aggregate

  python ./percy/examples/aggregate_deps_issue_finder/aggregate_deps_issue_finder.py
