pkgs/sage-project-cookiecutter: Rename from sage-project

sagemath · Mar 18, 2024 · d7cbaca · d7cbaca
1 parent 6f45292
commit d7cbaca
Show file tree

Hide file tree

Showing 17 changed files with 17 additions and 4 deletions.
diff --git a/pkgs/sage-project/MANIFEST.in → pkgs/sage-project-cookiecutter/MANIFEST.in b/pkgs/sage-project/MANIFEST.in → pkgs/sage-project-cookiecutter/MANIFEST.in
diff --git a/pkgs/sage-project/README.rst → pkgs/sage-project-cookiecutter/README.rst b/pkgs/sage-project/README.rst → pkgs/sage-project-cookiecutter/README.rst
@@ -25,7 +25,7 @@ Creating a user project
 
 ::
 
-   $ sage-project create PROJECT-DIRECTORY
+   $ sage-project-cookiecutter create PROJECT-DIRECTORY
 
 This creates configuration files:
 
@@ -34,7 +34,7 @@ This creates configuration files:
 
 It can also be invoked as follows::
 
-   $ pipx run cookiecutter gh:sagemath/sage --directory="pkgs/sage-project/sage_project/user-project-template"
+   $ pipx run cookiecutter gh:sagemath/sage --directory="pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template"
 
 See https://cookiecutter.readthedocs.io/en/latest/README.html for available options.
 
@@ -44,7 +44,7 @@ Creating a pip-installable downstream package
 
 ::
 
-  $ sage-project create --downstream-package PROJECT-DIRECTORY
+  $ sage-project-cookiecutter create --downstream-package PROJECT-DIRECTORY
 
 Additionally creates:
 
@@ -56,10 +56,23 @@ Adding Sage CI portability/integration testing infrastructure to an upstream pro
 
 ::
 
-   $ sage-project create --upstream-package PROJECT-DIRECTORY
+   $ sage-project-cookiecutter create --upstream-package PROJECT-DIRECTORY
 
 Creates:
 
 - ``.github/workflows/ci-sage.yml``
 - ``.devcontainer/portability-*``
 - ``.devcontainer/tox-docker-in-docker``
+
+
+Creating a pip-installable upstream package of the SageMath organization
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+   $ sage-project-cookiecutter create --sagemath-upstream-package PROJECT-DIRECTORY
+
+Additionally creates:
+
+- ``CODE_OF_CONDUCT.md``
+- ``CONTRIBUTING.md``
diff --git a/pkgs/sage-project/VERSION.txt → pkgs/sage-project-cookiecutter/VERSION.txt b/pkgs/sage-project/VERSION.txt → pkgs/sage-project-cookiecutter/VERSION.txt
diff --git a/pkgs/sage-project/pyproject.toml → .../sage-project-cookiecutter/pyproject.toml b/pkgs/sage-project/pyproject.toml → .../sage-project-cookiecutter/pyproject.toml
diff --git a/...stream-package-template/cookiecutter.json → ...stream-package-template/cookiecutter.json b/...stream-package-template/cookiecutter.json → ...stream-package-template/cookiecutter.json
diff --git a/...stream-package-template/cookiecutter.json → ...stream-package-template/cookiecutter.json b/...stream-package-template/cookiecutter.json → ...stream-package-template/cookiecutter.json
diff --git a/...t/user-project-template/cookiecutter.json → ...r/user-project-template/cookiecutter.json b/...t/user-project-template/cookiecutter.json → ...r/user-project-template/cookiecutter.json
diff --git a/....devcontainer/downstream-archlinux-latest → ....devcontainer/downstream-archlinux-latest b/....devcontainer/downstream-archlinux-latest → ....devcontainer/downstream-archlinux-latest
diff --git a/...evcontainer/downstream-conda-forge-latest → ...evcontainer/downstream-conda-forge-latest b/...evcontainer/downstream-conda-forge-latest → ...evcontainer/downstream-conda-forge-latest
diff --git a/...}}/.devcontainer/downstream-docker-cocalc → ...}}/.devcontainer/downstream-docker-cocalc b/...}}/.devcontainer/downstream-docker-cocalc → ...}}/.devcontainer/downstream-docker-cocalc
diff --git a/.../.devcontainer/downstream-docker-computop → .../.devcontainer/downstream-docker-computop b/.../.devcontainer/downstream-docker-computop → .../.devcontainer/downstream-docker-computop
diff --git a/...ainer/downstream-docker-sagemath-sagemath → ...ainer/downstream-docker-sagemath-sagemath b/...ainer/downstream-docker-sagemath-sagemath → ...ainer/downstream-docker-sagemath-sagemath
diff --git a/...wnstream-docker-sagemath-sagemath-develop → ...wnstream-docker-sagemath-sagemath-develop b/...wnstream-docker-sagemath-sagemath-develop → ...wnstream-docker-sagemath-sagemath-develop
diff --git a/...wnstream-docker-sagemathinc-sagemath-core → ...wnstream-docker-sagemathinc-sagemath-core b/...wnstream-docker-sagemathinc-sagemath-core → ...wnstream-docker-sagemathinc-sagemath-core
diff --git a/...ct_name}}/.devcontainer/onCreate-conda.sh → ...ct_name}}/.devcontainer/onCreate-conda.sh b/...ct_name}}/.devcontainer/onCreate-conda.sh → ...ct_name}}/.devcontainer/onCreate-conda.sh
diff --git a/....project_name}}/.devcontainer/onCreate.sh → ....project_name}}/.devcontainer/onCreate.sh b/....project_name}}/.devcontainer/onCreate.sh → ....project_name}}/.devcontainer/onCreate.sh
diff --git a/...okiecutter.project_name}}/environment.yml → ...okiecutter.project_name}}/environment.yml b/...okiecutter.project_name}}/environment.yml → ...okiecutter.project_name}}/environment.yml