You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/maintainer/adding_pkgs.rst
+21-6Lines changed: 21 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,13 +24,28 @@ Generating the recipe
24
24
25
25
There are, currently, three ways to generate a recipe:
26
26
27
-
#. If it is an R package from `CRAN <https://cran.r-project.org/>`_, kindly
27
+
1. If it is an R package from `CRAN <https://cran.r-project.org/>`_, kindly
28
28
start by using the `conda-forge helper script for R recipes <https://github.com/bgruening/conda_r_skeleton_helper>`_ instead.
29
29
Then if necessary, you can make manual edits to the recipe.
30
-
#. If it is a python package, you can generate the recipe as a starting point with ``grayskull``.
31
-
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
32
-
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>`__.
33
-
#. 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.
30
+
31
+
2. If it is a python package, you can generate the recipe as a starting point with ``grayskull``.
32
+
33
+
.. note::
34
+
35
+
`Grayskull <https://github.com/conda-incubator/grayskull>`_ is an automatic conda recipe generator. The goal of this project is to generate concise recipes
36
+
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.
37
+
38
+
Installation and usage of ``grayskull``:
39
+
40
+
- Create a new environment using : ``conda create --name MY_ENV``. Replace ``MY_ENV`` with the environment name.
41
+
- Activate this new environment : ``conda activate MY_ENV``.
42
+
- Run ``conda install -c conda-forge grayskull`` to install ``grayskull``.
43
+
- Followed by ``grayskull pypi --strict-conda-forge YOUR_PACKAGE_NAME`` to generate the recipe. Replace ``YOUR_PACKAGE_NAME`` with the package name.
44
+
45
+
You do *not* necessarily have to use ``grayskull``, and the recipes produced by ``grayskull`` might need to be reviewed and edited.
46
+
Read more about ``grayskull`` and how to use it `here <https://github.com/conda-incubator/grayskull#introduction>`__.
47
+
48
+
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.
34
49
35
50
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.
36
51
@@ -146,7 +161,7 @@ Maintainer role
146
161
The maintainer's job is to:
147
162
148
163
- Keep the feedstock updated by merging eventual maintenance :term:`PR`\ s from conda-forge's bots.
149
-
- Keep the feedstock on par with new releases of the source package by
164
+
- Keep the feedstock on par with new releases of the source package by:
150
165
151
166
- Bumping the version number and checksum.
152
167
- Making sure that the feedstock's requirements stay accurate.
0 commit comments