Skip to content

Commit f9515ac

Browse files
committed
Add more information about Grayskull
1 parent 7c8e248 commit f9515ac

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

src/maintainer/adding_pkgs.rst

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,28 @@ Generating the recipe
2929

3030
There are, currently, three ways to generate a recipe:
3131

32-
#. If it is an R package from `CRAN <https://cran.r-project.org/>`_, kindly
32+
1. If it is an R package from `CRAN <https://cran.r-project.org/>`_, kindly
3333
start by using the `conda-forge helper script for R recipes <https://github.com/bgruening/conda_r_skeleton_helper>`_ instead.
3434
Then if necessary, you can make manual edits to the recipe.
35-
#. If it is a python package, you can generate the recipe as a starting point with ``grayskull``.
36-
Use ``conda install -c conda-forge grayskull`` to install ``grayskull``, followed by ``grayskull pypi your_package_name`` to generate the recipe. Note that you do *not* necessarily have to use ``grayskull``, and the
37-
recipes produced by ``grayskull`` might need to be reviewed and edited. Read more about ``grayskull`` and how to use it `here <https://github.com/conda-incubator/grayskull#introduction>`__.
38-
#. If it's none of the above, generate a recipe with the help of `the example recipe <https://github.com/conda-forge/staged-recipes/tree/master/recipes/example>`_ in the `staged-recipes repository <https://github.com/conda-forge/staged-recipes>`_ and modify it as necessary.
35+
36+
2. If it is a python package, you can generate the recipe as a starting point with ``grayskull``.
37+
38+
.. note::
39+
40+
`Grayskull <https://github.com/conda-incubator/grayskull>`_ is an automatic conda recipe generator. The goal of this project is to generate concise recipes
41+
for conda-forge and eventually replace conda skeleton. Presently, Grayskull can generate recipes for Python packages available on PyPI and also those not published on PyPI and only available as GitHub repositories.
42+
43+
Installation and usage of ``grayskull``:
44+
45+
- Create a new environment using : ``conda create --name MY_ENV``. Replace ``MY_ENV`` with the environment name.
46+
- Activate this new environment : ``conda activate MY_ENV``.
47+
- Run ``conda install -c conda-forge grayskull`` to install ``grayskull``.
48+
- Followed by ``grayskull pypi --strict-conda-forge YOUR_PACKAGE_NAME`` to generate the recipe. Replace ``YOUR_PACKAGE_NAME`` with the package name.
49+
50+
You do *not* necessarily have to use ``grayskull``, and the recipes produced by ``grayskull`` might need to be reviewed and edited.
51+
Read more about ``grayskull`` and how to use it `here <https://github.com/conda-incubator/grayskull#introduction>`__.
52+
53+
3. If it's none of the above, generate a recipe with the help of `the example recipe <https://github.com/conda-forge/staged-recipes/tree/master/recipes/example>`_ in the `staged-recipes repository <https://github.com/conda-forge/staged-recipes>`_ and modify it as necessary.
3954

4055
Your final recipe should have no comments (unless they're actually relevant to the recipe, and not generic instruction comments), and follow the order in the example.
4156

@@ -121,7 +136,7 @@ Maintainer role
121136
The maintainer's job is to:
122137

123138
- Keep the feedstock updated by merging eventual maintenance :term:`PR`\ s from conda-forge's bots.
124-
- Keep the feedstock on par with new releases of the source package by
139+
- Keep the feedstock on par with new releases of the source package by:
125140

126141
- Bumping the version number and checksum.
127142
- Making sure that the feedstock's requirements stay accurate.

0 commit comments

Comments
 (0)