https://github.com/conda/grayskull
Grayskull :skull: - Recipe generator for Conda
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 43 committers (2.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.2%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Grayskull :skull: - Recipe generator for Conda
Basic Info
- Host: GitHub
- Owner: conda
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://conda.github.io/grayskull/
- Size: 2.59 MB
Statistics
- Stars: 352
- Watchers: 7
- Forks: 78
- Open Issues: 64
- Releases: 79
Topics
Metadata Files
README.md
Grayskull
"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.
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-urlis a replacement for--pypi-url;--pypi-urlis deprecated and will be removed in a future release.
Checking package availability against custom indexes
By default, Grayskull checks if packages are available on conda-forge and highlights missing dependencies. You can specify custom package indexes to check against using the --package-indexes argument:
bash
grayskull pypi --package-indexes my-channel company-channel conda-forge pytest
This will check if packages exist in my-channel, company-channel, or conda-forge (in that order) and mark them accordingly in the output.
You can also specify full URLs for internal package indexes that don't use anaconda.org:
bash
grayskull pypi --package-indexes https://internal-conda.example.com http://another-conda.example.com conda-forge pytest
Both HTTP and HTTPS protocols are supported for custom package indexes. This is particularly useful for internal networks that don't have access to anaconda.org.
For internal package indexes with custom API structures, you can use the {pkg_name} placeholder in your URL:
bash
grayskull pypi --package-indexes "https://internal-conda.example.com/api/{pkg_name}/available" conda-forge pytest
This allows you to specify exactly how your internal package index API works, rather than using the default /pkg_name/files path structure.
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-2023.
Distributed under the terms of the Apache 2.0 license, grayskull is free and open source software.
Owner
- Name: conda
- Login: conda
- Kind: organization
- Website: https://conda.org
- Twitter: condaproject
- Repositories: 29
- Profile: https://github.com/conda
conda is system-level, binary package and environment manager running on all major operating systems and platforms.
GitHub Events
Total
- Create event: 16
- Release event: 5
- Issues event: 20
- Watch event: 37
- Delete event: 14
- Issue comment event: 95
- Push event: 56
- Pull request review comment event: 17
- Pull request review event: 33
- Pull request event: 70
- Fork event: 12
Last Year
- Create event: 16
- Release event: 5
- Issues event: 20
- Watch event: 37
- Delete event: 14
- Issue comment event: 95
- Push event: 56
- Pull request review comment event: 17
- Pull request review event: 33
- Pull request event: 70
- Fork event: 12
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Marcelo Duarte Trevisani | m****i | 268 |
| pre-commit-ci[bot] | 6****] | 28 |
| Ben Mares | s****1@t****m | 14 |
| Benjamin Bertrand | b****e@g****m | 13 |
| Bastian Zimmermann | 1****m | 11 |
| Mahe Iram Khan | 6****e | 10 |
| woutdenolf | w****f@u****t | 10 |
| conda-bot | 1****t | 9 |
| Filipe | o****f@g****m | 8 |
| Xylar Asay-Davis | x****m@g****m | 6 |
| Duncan Macleod | d****d@l****g | 5 |
| Uwe L. Korn | u****n@q****m | 4 |
| Mike Taves | m****s@g****m | 3 |
| Jack Olivieri | b****4@g****m | 2 |
| Jannis Leidel | j****s@l****o | 2 |
| Lorenzo Pirritano | 6****i | 2 |
| Tobias Diez | c****e@t****m | 2 |
| Wei Ji | 2****4 | 2 |
| denivyruck | d****1@g****m | 2 |
| maxbachmann | s****h@m****e | 2 |
| Angus Hollands | g****5@g****m | 1 |
| Anselm Hahn | A****n@g****m | 1 |
| lgtm-com[bot] | 4****] | 1 |
| jan00s | 7****s | 1 |
| david qiu | d****d@q****v | 1 |
| candalfigomoro | c****o@o****m | 1 |
| Sterling Baird | 4****d | 1 |
| Stefanie Molin | 2****n | 1 |
| Silvio Traversaro | s****o@t****t | 1 |
| Schuyler Martin | s****5@g****m | 1 |
| and 13 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 5 months ago
All Time
- Total issues: 96
- Total pull requests: 231
- Average time to close issues: 8 months
- Average time to close pull requests: 22 days
- Total issue authors: 59
- Total pull request authors: 43
- Average comments per issue: 2.79
- Average comments per pull request: 1.6
- Merged pull requests: 182
- Bot issues: 1
- Bot pull requests: 46
Past Year
- Issues: 16
- Pull requests: 93
- Average time to close issues: 4 days
- Average time to close pull requests: 6 days
- Issue authors: 12
- Pull request authors: 21
- Average comments per issue: 0.19
- Average comments per pull request: 0.91
- Merged pull requests: 70
- Bot issues: 1
- Bot pull requests: 29
Top Authors
Issue Authors
- BastianZim (7)
- marcelotrevisani (7)
- woutdenolf (5)
- xylar (5)
- maresb (4)
- ubaldot (3)
- ForgottenProgramme (3)
- jdblischak (3)
- dhirschfeld (3)
- CatChenal (2)
- jakirkham (2)
- matthewfeickert (2)
- beckermr (2)
- dholth (2)
- ocefpaf (2)
Pull Request Authors
- pre-commit-ci[bot] (45)
- marcelotrevisani (42)
- maresb (21)
- conda-bot (16)
- beenje (11)
- woutdenolf (7)
- xylar (7)
- xhochy (6)
- ocefpaf (5)
- BastianZim (5)
- lorepirri (4)
- tobiasdiez (4)
- duncanmmacleod (4)
- mwtoews (3)
- jakirkham (3)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 6
-
Total downloads:
- pypi 2,394 last-month
- homebrew 24 last-month
-
Total dependent packages: 23
(may contain duplicates) -
Total dependent repositories: 16
(may contain duplicates) - Total versions: 136
- Total maintainers: 2
pypi.org: grayskull
Project to generate recipes for conda packages
- Documentation: https://grayskull.readthedocs.io/
- License: Apache-2.0
-
Latest release: 2.9.1
published 10 months ago
Rankings
Maintainers (1)
spack.io: py-grayskull
Project to generate recipes for conda packages.
- Homepage: https://github.com/conda/grayskull
- License: []
-
Latest release: 2.7.3
published over 1 year ago
Rankings
Maintainers (1)
conda-forge.org: greyskull
- Homepage: https://pypi.org/project/grayskull/
- License: Apache-2.0
-
Latest release: 1.8.4
published over 3 years ago
Rankings
formulae.brew.sh: grayskull
Recipe generator for Conda
- Homepage: https://github.com/conda/grayskull
- License: Apache-2.0
-
Latest release: 2.9.1
published 10 months ago
Rankings
anaconda.org: grayskull
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.
- Homepage: https://github.com/conda/grayskull
- License: Apache-2.0
-
Latest release: 2.9.1
published 10 months ago
Rankings
anaconda.org: greyskull
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.
- Homepage: https://github.com/conda/grayskull
- License: Apache-2.0
-
Latest release: 2.9.1
published 10 months ago
Rankings
Dependencies
- colorama
- compilers
- conda-souschef >=2.2.1
- fortran-compiler
- mock
- numpy
- pip
- pkginfo
- progressbar2 >=3.53.0
- pytest
- pytest-console-scripts
- pytest-cov
- pytest-forked
- pytest-mock
- pytest-xdist
- python >=3.8
- rapidfuzz >=1.9.1
- requests
- setuptools >=30.3.0
- setuptools-scm
- stdlib-list
- tomli
- tomli-w
- colorama *
- conda-souschef *
- pip *
- pkginfo *
- progressbar2 *
- rapidfuzz *
- requests *
- ruamel.yaml *
- ruamel.yaml.jinja2 *
- setuptools *
- stdlib-list *
- tomli *
- tomli-w *
- actions/checkout v3 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/autobuild v2 composite
- github/codeql-action/init v2 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout master composite
- codecov/codecov-action v1 composite
- conda-incubator/setup-miniconda v2 composite
- beautifulsoup4 *
- colorama *
- conda-souschef >=2.2.3
- packaging >=21.3
- pip *
- pkginfo *
- progressbar2 >=3.53.0
- rapidfuzz >=1.7.1
- requests *
- ruamel.yaml >=0.16.10
- ruamel.yaml.jinja2 *
- setuptools >=30.3.0
- stdlib-list *
- tomli *
- tomli-w *