Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/conda/grayskull
Grayskull :skull: - Recipe generator for Conda
https://github.com/conda/grayskull
conda conda-build conda-build-recipes conda-packages conda-recipe hacktoberfest recipe skeleton
Last synced: 3 months ago
JSON representation
Grayskull :skull: - Recipe generator for Conda
- Host: GitHub
- URL: https://github.com/conda/grayskull
- Owner: conda
- License: apache-2.0
- Created: 2020-01-07T07:57:51.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-04T10:35:17.000Z (3 months ago)
- Last Synced: 2024-08-04T22:02:37.063Z (3 months ago)
- Topics: conda, conda-build, conda-build-recipes, conda-packages, conda-recipe, hacktoberfest, recipe, skeleton
- Language: Python
- Homepage: https://conda.github.io/grayskull/
- Size: 2.53 MB
- Stars: 306
- Watchers: 7
- Forks: 65
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Authors: AUTHORS
Awesome Lists containing this project
README
# Grayskull
-------------
[](https://github.com/conda/grayskull/actions/workflows/tests.yml) [](https://github.com/conda/grayskull/actions/workflows/publish_pypi.yml)
[](https://codecov.io/gh/conda/grayskull) [](https://github.com/psf/black)   [](https://badge.fury.io/py/grayskull) [](https://anaconda.org/conda-forge/grayskull) [](https://gitter.im/conda_grayskull/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-------------
"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](https://conda-forge.org/).
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.
Grayskull can also generate recipes for R packages published on CRAN.
Future versions of Grayskull will support recipe generation for packages of other repositories such as Conan and CPAN etc..
## Installation
It is possible to install this project using `pip`:
```bash
pip install grayskull
```
or `conda`, using the ``conda-forge`` channel:
```bash
conda install -c conda-forge grayskull
```
It is also possible to clone this repo and install it using `pip`:
```bash
git clone https://github.com/conda/grayskull.git
cd grayskull
pip install -e .
```
## Usage
It is pretty simple to use `grayskull`. Just call it, pass the repository
(`pypi` or `cran`) and the package name.
* Example:
```bash
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`):
If your package is a GitHub repository just replace the package name with the GitHub repository URL.
For example:
```bash
grayskull pypi https://github.com/confluentinc/confluent-kafka-python
```
You can also generate a recipe from a local sdist archive:
```bash
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.
### Use Grayskull with an internal package index
Grayskull can create recipes that point to any Python Package Index. Supply the `--pypi-mirror-url` keyword.
* Example:
```bash
grayskull pypi --pypi-mirror-url https://pypi.example.com pytest
```
The above will source packages from `https://pypi.example.com/packages/source/...`
This assumes that the mirror follows the same API as pypi _including_ hosting metadata at the `/pypi/{package_name}/json` endpoint.
To specify an alternate metadata location use the `--pypi-metadata-url` option.
* Example:
```bash
grayskull pypi --pypi-mirror-url https://pypi.example.com --pypi-metadata-url https://pypi_meta.example.com pytest
```
> *Note:* `--pypi-metadata-url` is a replacement for `--pypi-url`; `--pypi-url` is deprecated and will be removed in a future release.
### Online Grayskull
It is also possible to use Grayskull without any installation. You can go to this website [marcelotrevisani.com/grayskull](https://www.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-2023.
Distributed under the terms of the Apache 2.0 license, grayskull is free and open source software.