From aed4ff2b4d88c282f32face4fe59a22c8a4c61d2 Mon Sep 17 00:00:00 2001 From: Matthias Koeppe Date: Sun, 17 Mar 2024 23:11:38 -0700 Subject: [PATCH] pkgs/sage-project-cookiecutter: Rename from sage-project --- .../MANIFEST.in | 0 .../README.rst | 21 +++++++++++++++---- .../VERSION.txt | 0 .../pyproject.toml | 6 ++++-- .../cookiecutter.json | 0 .../cookiecutter.json | 0 .../user-project-template/cookiecutter.json | 0 .../.devcontainer/downstream-archlinux-latest | 0 .../downstream-conda-forge-latest | 0 .../.devcontainer/downstream-docker-cocalc | 0 .../.devcontainer/downstream-docker-computop | 0 .../downstream-docker-sagemath-sagemath | 0 ...ownstream-docker-sagemath-sagemath-develop | 0 ...ownstream-docker-sagemathinc-sagemath-core | 0 .../.devcontainer/onCreate-conda.sh | 0 .../.devcontainer/onCreate.sh | 0 .../environment.yml | 0 17 files changed, 21 insertions(+), 6 deletions(-) rename pkgs/{sage-project => sage-project-cookiecutter}/MANIFEST.in (100%) rename pkgs/{sage-project => sage-project-cookiecutter}/README.rst (76%) rename pkgs/{sage-project => sage-project-cookiecutter}/VERSION.txt (100%) rename pkgs/{sage-project => sage-project-cookiecutter}/pyproject.toml (91%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/downstream-package-template/cookiecutter.json (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/upstream-package-template/cookiecutter.json (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/cookiecutter.json (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-archlinux-latest (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-conda-forge-latest (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-cocalc (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-computop (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath-develop (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemathinc-sagemath-core (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate-conda.sh (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate.sh (100%) rename pkgs/{sage-project/sage_project => sage-project-cookiecutter/sage_project_cookiecutter}/user-project-template/{{cookiecutter.project_name}}/environment.yml (100%) diff --git a/pkgs/sage-project/MANIFEST.in b/pkgs/sage-project-cookiecutter/MANIFEST.in similarity index 100% rename from pkgs/sage-project/MANIFEST.in rename to pkgs/sage-project-cookiecutter/MANIFEST.in diff --git a/pkgs/sage-project/README.rst b/pkgs/sage-project-cookiecutter/README.rst similarity index 76% rename from pkgs/sage-project/README.rst rename to pkgs/sage-project-cookiecutter/README.rst index 177d663f467..f48ea83f4bd 100644 --- a/pkgs/sage-project/README.rst +++ b/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 b/pkgs/sage-project-cookiecutter/VERSION.txt similarity index 100% rename from pkgs/sage-project/VERSION.txt rename to pkgs/sage-project-cookiecutter/VERSION.txt diff --git a/pkgs/sage-project/pyproject.toml b/pkgs/sage-project-cookiecutter/pyproject.toml similarity index 91% rename from pkgs/sage-project/pyproject.toml rename to pkgs/sage-project-cookiecutter/pyproject.toml index cbfd62d4760..740cbeb8a83 100644 --- a/pkgs/sage-project/pyproject.toml +++ b/pkgs/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/pkgs/sage-project/sage_project/downstream-package-template/cookiecutter.json b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/downstream-package-template/cookiecutter.json similarity index 100% rename from pkgs/sage-project/sage_project/downstream-package-template/cookiecutter.json rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/downstream-package-template/cookiecutter.json diff --git a/pkgs/sage-project/sage_project/upstream-package-template/cookiecutter.json b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/upstream-package-template/cookiecutter.json similarity index 100% rename from pkgs/sage-project/sage_project/upstream-package-template/cookiecutter.json rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/upstream-package-template/cookiecutter.json diff --git a/pkgs/sage-project/sage_project/user-project-template/cookiecutter.json b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/cookiecutter.json similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/cookiecutter.json rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/cookiecutter.json diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-archlinux-latest b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-archlinux-latest similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-archlinux-latest rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-archlinux-latest diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-conda-forge-latest b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-conda-forge-latest similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-conda-forge-latest rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-conda-forge-latest diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-cocalc b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-cocalc similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-cocalc rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-cocalc diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-computop b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-computop similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-computop rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-computop diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath-develop b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath-develop similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath-develop rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemath-sagemath-develop diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemathinc-sagemath-core b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemathinc-sagemath-core similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemathinc-sagemath-core rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/downstream-docker-sagemathinc-sagemath-core diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate-conda.sh b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate-conda.sh similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate-conda.sh rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate-conda.sh diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate.sh b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate.sh similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate.sh rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/.devcontainer/onCreate.sh diff --git a/pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/environment.yml b/pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/environment.yml similarity index 100% rename from pkgs/sage-project/sage_project/user-project-template/{{cookiecutter.project_name}}/environment.yml rename to pkgs/sage-project-cookiecutter/sage_project_cookiecutter/user-project-template/{{cookiecutter.project_name}}/environment.yml