Command Line

Grayskull - Conda recipe generator

usage: grayskull [-h] [--version] {cran,pypi} ...

Named Arguments

--version, -v

Print Grayskull version and exit

Default: False

Sub-commands

cran

Options to generate CRAN recipes

grayskull cran [-h] [--stdout STDOUT] [--list-missing-deps] [--download]
               [--maintainers MAINTAINERS [MAINTAINERS ...]] [--output OUTPUT]
               [--strict-conda-forge]
               [--sections {package,source,build,requirements,test,about,extra} [{package,source,build,requirements,test,about,extra} ...]]
               cran_packages [cran_packages ...]

Positional Arguments

cran_packages

Specify the CRAN packages name.

Default: []

Named Arguments

--stdout

Disable or enable stdout, if it is False, Grayskull will disable the prints. Default is True

Default: True

--list-missing-deps

After the execution Grayskull will print all the missing dependencies.

Default: False

--download, -d

Download the sdist package and PyPI information in the same folder the recipe is located.

Default: False

--maintainers, -m

List of maintainers which will be added to the recipe.

--output, -o

Path to where the recipe will be created

Default: “.”

--strict-conda-forge

It will generate the recipes strict for the conda-forge channel.

Default: False

--sections, -s

Possible choices: package, source, build, requirements, test, about, extra

If sections are specified, grayskull will populate just the sections informed.

pypi

Options to generate PyPI recipes

grayskull pypi [-h] [--download] [--maintainers MAINTAINERS [MAINTAINERS ...]]
               [--output OUTPUT] [--stdout STDOUT] [--list-missing-deps]
               [--strict-conda-forge] [--pypi-url URL_PYPI_METADATA]
               [--recursive]
               [--sections {package,source,build,requirements,test,about,extra} [{package,source,build,requirements,test,about,extra} ...]]
               [--extras-require-test EXTRAS_REQUIRE_TEST]
               [--tag GITHUB_RELEASE_TAG] [--extras-require-all]
               [--extras-require-include [EXTRAS_REQUIRE_INCLUDE ...]]
               [--extras-require-exclude [EXTRAS_REQUIRE_EXCLUDE ...]]
               [--extras-require-split]
               [--licence-exclude-folders [LICENCE_EXCLUDE_FOLDERS ...]]
               pypi_packages [pypi_packages ...]

Positional Arguments

pypi_packages

Specify the PyPI packages name. Grayskull can also accept a github url.

Default: []

Named Arguments

--download, -d

Download the sdist package and PyPI information in the same folder the recipe is located.

Default: False

--maintainers, -m

List of maintainers which will be added to the recipe.

--output, -o

Path to where the recipe will be created

Default: “.”

--stdout

Disable or enable stdout, if it is False, Grayskull will disable the prints. Default is True

Default: True

--list-missing-deps

After the execution Grayskull will print all the missing dependencies.

Default: False

--strict-conda-forge

It will generate the recipes strict for the conda-forge channel.

Default: False

--pypi-url

Pypi url server

Default: “https://pypi.org/pypi/”

--recursive, -r

Recursively run grayskull on missing dependencies.

Default: False

--sections, -s

Possible choices: package, source, build, requirements, test, about, extra

If sections are specified, grayskull will populate just the sections informed.

--extras-require-test

Extra requirements to run tests.

--tag, -t

If tag is specified, grayskull will build from release tag

--extras-require-all

Include all extra requirements.

Default: False

--extras-require-include

Include these extra requirements.

Default: ()

--extras-require-exclude

Exclude these extra requirements (overrides include).

Default: ()

--extras-require-split

Create a separate conda package for each extra requirements. Ignored when no extra requirements are selected.

Default: False

--licence-exclude-folders

Exclude folders when searching for licence.

Default: ()