From 492f0f1ec70ae1e520d2aa1ac765e3cc8215e718 Mon Sep 17 00:00:00 2001 From: Cornelius Roemer Date: Wed, 10 Jul 2024 20:12:40 +0200 Subject: [PATCH 1/3] doc: shorten grayskull usage by one step - It's more user friendly to provide ready to execute commands, e.g. an environment named `grayskull` makes sense if it's just `grayskull` that's installed there. - One can directly install grayskull upon env creation, this reduces the docs by one line, and also makes it faster to run --- docs/maintainer/adding_pkgs.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/maintainer/adding_pkgs.md b/docs/maintainer/adding_pkgs.md index fdc76ce3bf..630440ebe4 100644 --- a/docs/maintainer/adding_pkgs.md +++ b/docs/maintainer/adding_pkgs.md @@ -55,9 +55,8 @@ There are, currently, three ways to generate a recipe: Installation and usage of `grayskull`: - - Create a new environment using : `conda create --name MY_ENV`. Replace `MY_ENV` with the environment name. - - Activate this new environment : `conda activate MY_ENV`. - - Run `conda install -c conda-forge grayskull` to install `grayskull`. + - Create a new environment named e.g. "grayskull" with grayskull installed : `conda create --name grayskull -c conda-forge grayskull` + - Activate this new environment : `conda activate grayskull`. - Followed by `grayskull pypi --strict-conda-forge YOUR_PACKAGE_NAME` to generate the recipe. Replace `YOUR_PACKAGE_NAME` with the package name. ::: From e9d19e0199df84732cc55be73378d8b108282323 Mon Sep 17 00:00:00 2001 From: Cornelius Roemer Date: Wed, 10 Jul 2024 20:14:45 +0200 Subject: [PATCH 2/3] Use conda run to cut down by a further line --- docs/maintainer/adding_pkgs.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/maintainer/adding_pkgs.md b/docs/maintainer/adding_pkgs.md index 630440ebe4..47edf0317e 100644 --- a/docs/maintainer/adding_pkgs.md +++ b/docs/maintainer/adding_pkgs.md @@ -56,8 +56,7 @@ There are, currently, three ways to generate a recipe: Installation and usage of `grayskull`: - Create a new environment named e.g. "grayskull" with grayskull installed : `conda create --name grayskull -c conda-forge grayskull` - - Activate this new environment : `conda activate grayskull`. - - Followed by `grayskull pypi --strict-conda-forge YOUR_PACKAGE_NAME` to generate the recipe. Replace `YOUR_PACKAGE_NAME` with the package name. + - Run the grayskull command in the newly created environment through `conda run -n grayskull grayskull pypi --strict-conda-forge YOUR_PACKAGE_NAME` to generate the recipe. Replace `YOUR_PACKAGE_NAME` with the package name. The package will be in the folder `YOUR_PACKAGE_NAME` in the working directory. ::: From 8f38b3ebf82540db152ea61707d3c8a06ee9d7bc Mon Sep 17 00:00:00 2001 From: Cornelius Roemer Date: Thu, 11 Jul 2024 23:05:13 +0200 Subject: [PATCH 3/3] Update docs/maintainer/adding_pkgs.md Co-authored-by: jaimergp --- docs/maintainer/adding_pkgs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintainer/adding_pkgs.md b/docs/maintainer/adding_pkgs.md index 47edf0317e..30be5a9174 100644 --- a/docs/maintainer/adding_pkgs.md +++ b/docs/maintainer/adding_pkgs.md @@ -56,7 +56,7 @@ There are, currently, three ways to generate a recipe: Installation and usage of `grayskull`: - Create a new environment named e.g. "grayskull" with grayskull installed : `conda create --name grayskull -c conda-forge grayskull` - - Run the grayskull command in the newly created environment through `conda run -n grayskull grayskull pypi --strict-conda-forge YOUR_PACKAGE_NAME` to generate the recipe. Replace `YOUR_PACKAGE_NAME` with the package name. The package will be in the folder `YOUR_PACKAGE_NAME` in the working directory. + - Run the grayskull command in the newly created environment through `conda run --no-capture-output -n grayskull grayskull pypi --strict-conda-forge YOUR_PACKAGE_NAME` to generate the recipe. Replace `YOUR_PACKAGE_NAME` with the package name. The package will be in the folder `YOUR_PACKAGE_NAME` in the working directory. :::