Skip to main content

Project to generate recipes for conda packages.

Project description

Grayskull


Tests Checkers Deployment (PyPI)

codecov Code style: black PyPI version Conda Version Gitter Language grade: Python




"Skeletonr's main goal is to conquer the mysterious fortress of Castle Grayskull, from which He-Man draws his powers. If he succeeds, Skeletor would be able to conquer not only Eternia, but the whole universe."
Adapted from Wikipedia. Image credits: https://he-man.fandom.com

Introduction

Grayskull is an automatic conda recipe generator.
The main goal of this project is to generate concise recipes for conda-forge. The Grayskull project was created with the intention to eventually replace conda skeleton.
Presently Grayskull can generate recipes for Python packages available on PyPI and also those not published on PyPI but available as GitHub repositories. Future versions of Grayskull will support recipe generation for packages of other repositories such as CRAN and Conan etc..

Installation

It is possible to install this project using pip:

pip install grayskull

or conda, using the conda-forge channel:

conda install -c conda-forge grayskull

It is also possible to clone this repo and install it using pip:

git clone https://github.com/conda-incubator/grayskull.git
cd grayskull
pip install -e .

Usage

It is pretty simple to use grayskull. Just call it, pass the repository (just pypi for now) and the package name.

  • Example:
grayskull pypi pytest

After that grayskull will create a folder with the same name as the package and inside this folder the generated recipe will be present (meta.yaml).

  • Example with pytest (grayskull pypi pytest):

Grayskull CLI

If your package is a GitHub repository just replace the package name with the GitHub repository URL.
For example:

grayskull pypi https://github.com/confluentinc/confluent-kafka-python

You can also generate a recipe from a local sdist archive:

grayskull pypi ./pytest-5.3.5.tar.gz

Note that such a recipe isn't really portable as it will depend on the local path of the sdist file. It can be useful if you want to automatically generate a conda package.

Online Grayskull

It is also possible to use Grayskull without any installation. You can go to this website marcelotrevisani.com/grayskull and inform the name and the version (optional) of the package and it will create the recipe for you.

License

Copyright Marcelo Duarte Trevisani and contributors, 2020-2022.

Distributed under the terms of the Apache 2.0 license, grayskull is free and open source software.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grayskull-1.7.0.tar.gz (2.0 MB view hashes)

Uploaded Source

Built Distribution

grayskull-1.7.0-py3-none-any.whl (168.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page