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

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

Hide file tree

Showing 17 changed files with 21 additions and 6 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
@@ -3,7 +3,7 @@ requires = ["setuptools>=61.2"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "sage-project"
+name = "sage-project-cookiecutter"
 description = "Sage: Open Source Mathematics Software: Script for maintaining a SageMath-based project"
 license = {text = "GNU General Public License (GPL) v2 or later"}
 authors = [{name = "The Sage Developers", email = "sage-support@googlegroups.com"}]
@@ -18,12 +18,14 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: Implementation :: CPython",
     "Topic :: Scientific/Engineering :: Mathematics",
 ]
 urls = {Homepage = "https://www.sagemath.org"}
 dependencies = [
     "cookiecutter",
+    "cruft",
 ]
 dynamic = ["version"]
 
@@ -38,7 +40,7 @@ packages = [
 include-package-data = false
 
 [tools.setuptools.package-data]
-"sage_project" = [
+"sage_project_cookiecutter" = [
     "template*/**"
 ]
 

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