| Name | grayskull JSON |
| Version |
2.7.3
JSON |
| download |
| home_page | None |
| Summary | Project to generate recipes for conda packages |
| upload_time | 2024-09-29 11:51:04 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
conda
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# 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)
-------------
<span align="center">
<br>
<img src="https://static.wikia.nocookie.net/heman/images/3/33/Grayskull.jpg" align="center" />
<br>
<i>"Skeleto<strike>n</strike>r'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."</i> </br>Adapted from <a href=https://en.wikipedia.org/wiki/Skeletor>Wikipedia</a>. Image credits: <a href=https://he-man.fandom.com>https://he-man.fandom.com</a>
</span>
-------------
## Introduction
Grayskull is an automatic conda recipe generator. <br>
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`. <br>
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. <br>
For example: <br>
```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.
Raw data
{
"_id": null,
"home_page": null,
"name": "grayskull",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "conda",
"author": null,
"author_email": "Marcelo Duarte Trevisani <marceloduartetrevisani@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/95/9f/ace91b84daf25219c9b902b492683a245afb9b697210fe6be0653bf1ef14/grayskull-2.7.3.tar.gz",
"platform": null,
"description": "# Grayskull\n-------------\n[](https://github.com/conda/grayskull/actions/workflows/tests.yml) [](https://github.com/conda/grayskull/actions/workflows/publish_pypi.yml)\n\n[](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)\n\n-------------\n<span align=\"center\">\n <br>\n <img src=\"https://static.wikia.nocookie.net/heman/images/3/33/Grayskull.jpg\" align=\"center\" />\n <br>\n <i>\"Skeleto<strike>n</strike>r'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.\"</i> </br>Adapted from <a href=https://en.wikipedia.org/wiki/Skeletor>Wikipedia</a>. Image credits: <a href=https://he-man.fandom.com>https://he-man.fandom.com</a>\n</span>\n\n\n-------------\n## Introduction\n\nGrayskull is an automatic conda recipe generator. <br>\nThe main goal of this project is to generate concise recipes\nfor [conda-forge](https://conda-forge.org/).\nThe Grayskull project was created with the intention to eventually replace `conda skeleton`. <br>\nPresently Grayskull can generate recipes for Python packages available on PyPI and also those not published on PyPI but available as GitHub repositories.\nGrayskull can also generate recipes for R packages published on CRAN.\nFuture versions of Grayskull will support recipe generation for packages of other repositories such as Conan and CPAN etc..\n\n## Installation\n\nIt is possible to install this project using `pip`:\n```bash\npip install grayskull\n```\n\nor `conda`, using the ``conda-forge`` channel:\n```bash\nconda install -c conda-forge grayskull\n```\n\nIt is also possible to clone this repo and install it using `pip`:\n```bash\ngit clone https://github.com/conda/grayskull.git\ncd grayskull\npip install -e .\n```\n\n## Usage\n\nIt is pretty simple to use `grayskull`. Just call it, pass the repository\n (`pypi` or `cran`) and the package name.\n\n* Example:\n```bash\ngrayskull pypi pytest\n```\n\nAfter that `grayskull` will create a folder with the same name as the package\nand inside this folder the generated recipe will be present (`meta.yaml`).\n\n* Example with `pytest` (`grayskull pypi pytest`):\n\n\n\nIf your package is a GitHub repository just replace the package name with the GitHub repository URL. <br>\nFor example: <br>\n\n```bash\ngrayskull pypi https://github.com/confluentinc/confluent-kafka-python\n```\n\nYou can also generate a recipe from a local sdist archive:\n\n```bash\ngrayskull pypi ./pytest-5.3.5.tar.gz\n```\n\nNote that such a recipe isn't really portable as it will depend on the local path of the\nsdist file. It can be useful if you want to automatically generate a conda package.\n\n### Use Grayskull with an internal package index\n\nGrayskull can create recipes that point to any Python Package Index. Supply the `--pypi-mirror-url` keyword.\n\n* Example:\n```bash\ngrayskull pypi --pypi-mirror-url https://pypi.example.com pytest\n```\n\nThe above will source packages from `https://pypi.example.com/packages/source/...`\n\nThis assumes that the mirror follows the same API as pypi _including_ hosting metadata at the `/pypi/{package_name}/json` endpoint.\nTo specify an alternate metadata location use the `--pypi-metadata-url` option.\n\n* Example:\n```bash\ngrayskull pypi --pypi-mirror-url https://pypi.example.com --pypi-metadata-url https://pypi_meta.example.com pytest\n```\n\n> *Note:* `--pypi-metadata-url` is a replacement for `--pypi-url`; `--pypi-url` is deprecated and will be removed in a future release.\n\n### Online Grayskull\n\nIt 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.\n\n\n## License\nCopyright Marcelo Duarte Trevisani and contributors, 2020-2023.\n\nDistributed under the terms of the Apache 2.0 license, grayskull is free and open source software.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Project to generate recipes for conda packages",
"version": "2.7.3",
"project_urls": {
"Source": "https://github.com/conda/grayskull"
},
"split_keywords": [
"conda"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "77464f2c59e2212682e80da7a8b0cbf81780677aef289f80b200126ecccf6648",
"md5": "0fd2658fd2c672d1751b0a3568f1bb91",
"sha256": "6156f66bbeb5f426b5058112a6e9d46f24c6cc2f3904be3dbba6105000dd7d9b"
},
"downloads": -1,
"filename": "grayskull-2.7.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0fd2658fd2c672d1751b0a3568f1bb91",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 128925,
"upload_time": "2024-09-29T11:51:02",
"upload_time_iso_8601": "2024-09-29T11:51:02.536379Z",
"url": "https://files.pythonhosted.org/packages/77/46/4f2c59e2212682e80da7a8b0cbf81780677aef289f80b200126ecccf6648/grayskull-2.7.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "959face91b84daf25219c9b902b492683a245afb9b697210fe6be0653bf1ef14",
"md5": "038e3ad5949a7b5a3ca93cf659035648",
"sha256": "9396245439584b92d656fdefb03d6911b5987f91a5ae714772ddcb338768cbb9"
},
"downloads": -1,
"filename": "grayskull-2.7.3.tar.gz",
"has_sig": false,
"md5_digest": "038e3ad5949a7b5a3ca93cf659035648",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1943662,
"upload_time": "2024-09-29T11:51:04",
"upload_time_iso_8601": "2024-09-29T11:51:04.986717Z",
"url": "https://files.pythonhosted.org/packages/95/9f/ace91b84daf25219c9b902b492683a245afb9b697210fe6be0653bf1ef14/grayskull-2.7.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-29 11:51:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "conda",
"github_project": "grayskull",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "grayskull"
}
