Merge pull request #238 from bobleesj/scikit-package

chore: rename bg-cookiecutter and cookiecutter to `scikit-package` in project repo
Billingegroup · Jan 4, 2025 · a273b1a · a273b1a
2 parents 63a9a0b + 564f7b5
commit a273b1a
Show file tree

Hide file tree

Showing 35 changed files with 86 additions and 135 deletions.
diff --git a/.github/workflows/build-wheel-release-upload.yml b/.github/workflows/build-wheel-release-upload.yml
@@ -10,7 +10,7 @@ jobs:
   release:
     uses: Billingegroup/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
     with:
-      project: bg-cookiecutter
+      project: scikit-package
     secrets:
       PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
       PAT_TOKEN: ${{ secrets.PAT_TOKEN }}
diff --git a/.github/workflows/check-news-item.yml b/.github/workflows/check-news-item.yml
@@ -9,4 +9,4 @@ jobs:
   check-news-item:
     uses: Billingegroup/release-scripts/.github/workflows/_check-news-item.yml@v0
     with:
-      project: bg-cookiecutter
+      project: scikit-package
diff --git a/.github/workflows/matrix-and-codecov-on-merge-to-main.yml b/.github/workflows/matrix-and-codecov-on-merge-to-main.yml
@@ -14,7 +14,7 @@ jobs:
   matrix-coverage:
     uses: Billingegroup/release-scripts/.github/workflows/_matrix-and-codecov-on-merge-to-main.yml@v0
     with:
-      project: bg-cookiecutter
+      project: scikit-package
       c_extension: false
       headless: false
     secrets:

diff --git a/.github/workflows/publish-docs-on-release.yml b/.github/workflows/publish-docs-on-release.yml
@@ -1,14 +1,12 @@
-name: Deploy Documentation on Release
+name: Deploy Documentation
 
 on:
-  release:
-    types: [published]
   workflow_dispatch:
 
 jobs:
   docs:
     uses: Billingegroup/release-scripts/.github/workflows/_publish-docs-on-release.yml@v0
     with:
-      project: bg-cookiecutter
+      project: scikit-package
       c_extension: false
       headless: false
diff --git a/.github/workflows/tests-on-pr.yml b/.github/workflows/tests-on-pr.yml
@@ -11,7 +11,7 @@ jobs:
   tests-on-pr:
     uses: Billingegroup/release-scripts/.github/workflows/_tests-on-pr.yml@v0
     with:
-      project: bg-cookiecutter
+      project: scikit-package
       c_extension: false
       headless: false
     secrets:

diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -11,4 +11,4 @@ Contributors
 ------------
 
 For a list of contributors, visit
-https://github.com/Billingegroup/cookiecutter/graphs/contributors
+https://github.com/Billingegroup/scikit_package/graphs/contributors
diff --git a/README.rst b/README.rst
@@ -1,11 +1,11 @@
 |Icon| |title|_
 ===============
 
-.. |title| replace:: bg-cookiecutter
-.. _title: https://Billingegroup.github.io/cookiecutter
+.. |title| replace:: scikit-package
+.. _title: https://Billingegroup.github.io/scikit-package
 
 .. |Icon| image:: https://avatars.githubusercontent.com/Billingegroup
-        :target: https://Billingegroup.github.io/cookiecutter
+        :target: https://Billingegroup.github.io/scikit-package
         :height: 100px
 
 |PyPi| |Forge| |PythonVersion| |PR|
@@ -15,27 +15,27 @@
 .. |Black| image:: https://img.shields.io/badge/code_style-black-black
         :target: https://github.com/psf/black
 
-.. |CI| image:: https://github.com/Billingegroup/cookiecutter/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
-        :target: https://github.com/Billingegroup/cookiecutter/actions/workflows/matrix-and-codecov-on-merge-to-main.yml
+.. |CI| image:: https://github.com/Billingegroup/scikit-package/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
+        :target: https://github.com/Billingegroup/scikit-package/actions/workflows/matrix-and-codecov-on-merge-to-main.yml
 
-.. |Codecov| image:: https://codecov.io/gh/Billingegroup/cookiecutter/branch/main/graph/badge.svg
-        :target: https://codecov.io/gh/Billingegroup/cookiecutter
+.. |Codecov| image:: https://codecov.io/gh/Billingegroup/scikit-package/branch/main/graph/badge.svg
+        :target: https://codecov.io/gh/Billingegroup/scikit-package
 
-.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/bg-cookiecutter
-        :target: https://anaconda.org/conda-forge/bg-cookiecutter
+.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/scikit-package
+        :target: https://anaconda.org/conda-forge/scikit-package
 
 .. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
 
-.. |PyPi| image:: https://img.shields.io/pypi/v/bg-cookiecutter
-        :target: https://pypi.org/project/bg-cookiecutter/
+.. |PyPi| image:: https://img.shields.io/pypi/v/scikit-package
+        :target: https://pypi.org/project/scikit-package/
 
-.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/bg-cookiecutter
-        :target: https://pypi.org/project/bg-cookiecutter/
+.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/scikit-package
+        :target: https://pypi.org/project/scikit-package/
 
 .. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
-        :target: https://github.com/Billingegroup/cookiecutter/issues
+        :target: https://github.com/Billingegroup/scikit-package/issues
 
-``bg-cookiecutter`` is a Python package standard and generator for scientific code. Use ``bg-cookiecutter`` to launch a new project or migrate existing ones to support the latest Python versions and streamline the process of distributing and maintaining your software package.
+``scikit-package`` is a Python package standard and generator for scientific code. Use ``scikit-package`` to launch a new project or migrate existing ones to support the latest Python versions and streamline the process of distributing and maintaining your software package.
 
 - Automated `PEP8 <https://peps.python.org/pep-0008/>`_ and `PEP256 <https://peps.python.org/pep-0256/>`_ standard checks.
 - Automated PyPI/GitHub release, testing, documentation, and CHANGELOG updates.
@@ -48,17 +48,17 @@ Demo
 ----
 
 .. image:: doc/source/gif/demo.gif
-   :alt: bg-cookiecutter demo
+   :alt: scikit-package demo
    :align: center
 
 Getting started
 ---------------
 
-Are you interested in amplifying your scientific contribution by standarlizing and distributing your Python code? Begin with the ``Getting started`` page in our online documentation at https://Billingegroup.github.io/cookiecutter!
+Are you interested in amplifying your scientific contribution by standarlizing and distributing your Python code? Begin with the ``Getting started`` page in our online documentation at https://Billingegroup.github.io/scikit-package!
 
-How to cite bg-cookiecutter
+How to cite scikit-package
 ---------------------------
 
-If you use ``bg-cookiecutter`` to standardize your Python software, we would like you to cite bg-cookiecutter as follows:
+If you use ``scikit-package`` to standardize your Python software, we would like you to cite scikit-package as follows:
 
-   bg-cookiecutter, https://github.com/Billingegroup/cookiecutter
+   scikit-package, https://github.com/Billingegroup/scikit-package
diff --git a/doc/Makefile b/doc/Makefile
@@ -6,7 +6,7 @@ SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = build
-BASENAME      = $(subst .,,$(subst $() $(),,bg-cookiecutter))
+BASENAME      = $(subst .,,$(subst $() $(),,scikit-package))
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

diff --git a/doc/source/conda_forge_guide.rst b/doc/source/conda_forge_guide.rst
@@ -20,7 +20,7 @@ Hence, in Step 1, we will generate ``meta.yaml`` using the Billinge group's temp
 
 If you are interested in learning more about each component within ``meta.yaml``, read :ref:`Appendix 1 <appendix1>` located at the end of this document.
 
-1. Install ``cookiecutter`` via ``pip install cookiecutter`` and run ``cookiecutter https://github.com/billingegroup/staged-recipes-cookiecutter``
+1. Install ``scikit-package`` via ``pip install scikit-package`` and run ``scikit-package https://github.com/billingegroup/staged-recipes-cookiecutter``
 
 2. Answer the following questions. Default values in parentheses are used if no value is provided.
 

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# bg-cookiecutter documentation build configuration file, created by
+# scikit-package documentation build configuration file, created by
 # sphinx-quickstart on Thu Jan 30 15:49:41 2014.
 #
 # This file is execfile()d with the current directory set to its
@@ -71,7 +71,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = "bg-cookiecutter"
+project = "scikit-package"
 copyright = "%Y, The Trustees of Columbia University in the City of New York"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -121,7 +121,7 @@
 pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-modindex_common_prefix = ["bg-cookiecutter"]
+modindex_common_prefix = ["scikit-package"]
 
 # Display all warnings for missing links.
 nitpicky = True
@@ -212,7 +212,7 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-basename = "bg-cookiecutter".replace(" ", "").replace(".", "")
+basename = "scikit-package".replace(" ", "").replace(".", "")
 htmlhelp_basename = basename + "doc"
 
 
@@ -233,8 +233,8 @@
 latex_documents = [
     (
         "index",
-        "bg-cookiecutter.tex",
-        "bg-cookiecutter Documentation",
+        "scikit-package.tex",
+        "scikit-package Documentation",
         ab_authors,
         "manual",
     ),
@@ -268,8 +268,8 @@
 man_pages = [
     (
         "index",
-        "bg-cookiecutter",
-        "bg-cookiecutter Documentation",
+        "scikit-package",
+        "scikit-package Documentation",
         ab_authors,
         1,
     )
@@ -287,10 +287,10 @@
 texinfo_documents = [
     (
         "index",
-        "bg-cookiecutter",
-        "bg-cookiecutter Documentation",
+        "scikit-package",
+        "scikit-package Documentation",
         ab_authors,
-        "bg-cookiecutter",
+        "scikit-package",
         "One line description of project.",
         "Miscellaneous",
     ),

diff --git a/doc/source/frequently_asked_questions.rst b/doc/source/frequently_asked_questions.rst
@@ -8,7 +8,7 @@
 Frequently asked questions (FAQ)
 ================================
 
-Here, you will learn how to customize the ``bg-cookiecutter`` template for your own project, such as setting the line-width and including/excluding files for PyPI distribution. We also provide design decisions for the current setup of the ``bg-cookiecutter`` template.
+Here, you will learn how to customize the ``scikit-package`` template for your own project, such as setting the line-width and including/excluding files for PyPI distribution. We also provide design decisions for the current setup of the ``scikit-package`` template.
 
 Formatting
 ----------

diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst
@@ -11,13 +11,13 @@ Getting started
 Are you here for cookiecutting?
 -------------------------------
 
-1. Do you already have a Python package you want to standardize with ``bg-cookiecutter``? Please follow the full instructions :ref:`here <cookiecutter-title>`.
+1. Do you already have a Python package you want to standardize with ``scikit-package``? Please follow the full instructions :ref:`here <cookiecutter-title>`.
 
-2. Do you already have a bg-cookiecuttered package and you want to use the latest version? Please follow the instructions in :ref:`here <cookiecutter-workflow-main>`.
+2. Do you already have a scikit-packaged package and you want to use the latest version? Please follow the instructions in :ref:`here <cookiecutter-workflow-main>`.
 
-3. Do you want to start a new Python repository with ``bg-cookiecutter``? Start from the Cookiecutter workflow section :ref:`here <cookiecutter-workflow-main>`.
+3. Do you want to start a new Python repository with ``scikit-package``? Start from the Cookiecutter workflow section :ref:`here <cookiecutter-workflow-main>`.
 
 Are you here for release?
 -------------------------
 
-You already have a bg-cookiecuttered package. Do you want to release your package to ``GitHub``, ``PyPI``, and ``conda-forge`` by creating a tag to your GitHub repository? Start from :ref:`here <release_guide>`.
+You already have a package standardized with ``scikit-package``. Do you want to release your package to ``GitHub``, ``PyPI``, and ``conda-forge`` by creating a tag to your GitHub repository? Start from :ref:`here <release_guide>`.
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -2,7 +2,7 @@
 |title|
 #######
 
-.. |title| replace:: bg-cookiecutter documentation
+.. |title| replace:: scikit-package documentation
 
 | Software version |release|.
 | Last updated |today|.
@@ -12,14 +12,14 @@ Welcome to Billinge Group's Python cookiecutter documentation!
 Statement of need
 -----------------
 
-Your research impact can be amplified by distributing your contributions through well-documented software packages. However, creating these packages requires time dedicated to software infrastructure and ongoing maintenance. ``bg-cookiecutter`` is a Python package standard and generator that helps you launch new scientific code or migrate existing ones.
+Your research impact can be amplified by distributing your contributions through well-documented software packages. However, creating these packages requires time dedicated to software infrastructure and ongoing maintenance. ``scikit-package`` is a Python package standard and generator that helps you launch new scientific code or migrate existing ones.
 
-``bg-cookiecutter`` provides research-quality documents suitable for open-source development and supports Python versions compatible with the `SPEC0 <https://scientific-python.org/specs/spec-0000/>`_ proposal through automated workflows. Additionally, it offers a streamlined process for building and distributing your scientific software, ensuring reproducibility across all major operating systems. With ``bg-cookiecutter``, you can focus on developing your scientific code while ensuring it reaches a broader audience.
+``scikit-package`` provides research-quality documents suitable for open-source development and supports Python versions compatible with the `SPEC0 <https://scientific-python.org/specs/spec-0000/>`_ proposal through automated workflows. Additionally, it offers a streamlined process for building and distributing your scientific software, ensuring reproducibility across all major operating systems. With ``scikit-package``, you can focus on developing your scientific code while ensuring it reaches a broader audience.
 
 What are the useful features?
 -----------------------------
 
-To help increase your research impact, ``bg-cookiecutter`` offers the following features:
+To help increase your research impact, ``scikit-package`` offers the following features:
 
 - Automated `PEP8 <https://peps.python.org/pep-0008/>`_ and `PEP256 <https://peps.python.org/pep-0256/>`_ standard checks.
 - Automated PyPI/GitHub release, testing, documentation, and CHANGELOG updates.
@@ -52,7 +52,7 @@ How can I contribute?
 
 Do you have any new features? Please make an issue via the GitHub issue tracker for further discussions. For a minor typo or grammatically incorrect sentence, please make a pull request. Before making a PR, please run ``pre-commit run --all-files`` to ensure the code is formatted.
 
-Who are using ``bg-cookiecutter``?
+Who are using ``scikit-package``?
 ----------------------------------
 
 The full list of packages is as follows:
@@ -73,16 +73,16 @@ The full list of packages is as follows:
 Authors
 =======
 
-bg-cookiecutter is developed by Billinge Group and its community contributors.
+scikit-package is developed by Billinge Group and its community contributors.
 
 For a detailed list of contributors, see
-https://github.com/Billingegroup/cookiecutter/graphs/contributors.
+https://github.com/Billingegroup/scikit-package/graphs/contributors.
 
 ================
 Acknowledgements
 ================
 
-The Billinge Group's cookiecutter has been modified from the NSLS-II scientific cookiecutter: https://github.com/nsls-ii/scientific-python-cookiecutter
+The Billinge Group's scikit-package has been modified from the NSLS-II scientific cookiecutter: https://github.com/nsls-ii/scientific-python-cookiecutter
 
 =================
 Table of contents

diff --git a/environment.yml b/environment.yml
@@ -1,4 +1,4 @@
-name: bg-cookiecutter
+name: sckit-package
 channels:
   - conda-forge
 dependencies:

diff --git a/news/add-py-env.rst b/news/add-py-env.rst
@@ -1,6 +1,6 @@
 **Added:**
 
-* support for Billinge group's reusesable workflow by adding requirement files and environment.yml
+* Support Billinge group's reusesable workflow by adding requirement files and `environment.yml`.
 
 **Changed:**
 

diff --git a/news/codecov.rst b/news/codecov.rst
@@ -1,6 +1,6 @@
 **Added:**
 
-* instructions for Codecov setup in cookiecutter guide
+* Add instructions for Codecov setup in documentation.
 
 **Changed:**
 

diff --git a/news/conda-forge-doc.rst b/news/conda-forge-doc.rst
@@ -1,6 +1,6 @@
 **Added:**
 
-* conda-forge feedstock creation and maintenance guide
+* Add conda-forge feedstock creation and maintenance guide.
 
 **Changed:**
 

diff --git a/news/cookiecut.rst b/news/cookiecut.rst
@@ -4,7 +4,7 @@
 
 **Changed:**
 
-* package structure based on its own Billinge Group's Python bg-cookiecutter template
+* Standarlize the current repository based on `scikit-package` structure.
 
 **Deprecated:**
 

diff --git a/news/demo-gif.rst b/news/demo-gif.rst
@@ -1,6 +1,6 @@
 **Added:**
 
-* Add demo .gif file used in README.rst in generating a package and building documentation with `bg-cookiecutter`.
+* Add demo .gif file used in README.rst in generating a package and building documentation with `scikit-package`.
 
 **Changed:**
 

diff --git a/news/docformatter.rst b/news/docformatter.rst
@@ -1,6 +1,6 @@
 **Added:**
 
-* automatic docstring linting with PEP 257 compliance with docformatter in pre-commit
+* Add automatic docstring linting with PEP 257 compliance with `docformatter` in `pre-commit`.
 
 **Changed:**
 

diff --git a/news/dynamic-template.rst b/news/dynamic-template.rst
@@ -1,6 +1,6 @@
 **Added:**
 
-* extra metadata of email, name, username, license holder, etc. collected to dynamically populate rendered cookiecuttered files
+* Add extra metadata of email, name, username, license holder, etc. collected to dynamically populate rendered cookiecuttered files.
 
 **Changed:**
 

diff --git a/news/frequently-asked-questions.rst b/news/frequently-asked-questions.rst
@@ -1,6 +1,6 @@
 **Added:**
 
-* FAQ section to the documentation on how to customize the template and design decisions for the current setup
+* Add FAQ section to the documentation on how to customize the template and design decisions for the current setup.
 
 **Changed:**
 

diff --git a/news/getting-started.rst b/news/getting-started.rst
@@ -1,8 +1,8 @@
 **Added:**
 
-* Getting started page in documentation
-* FAQ section on why both pip.txt and conda.txt added
-* FAQ section on how version is set and retrieved dynamically
+* Add `Getting started`` page in documentation.
+* Add FAQ section on why both `pip.txt`` and `conda.txt`` added.
+* Add FAQ section on how version is set and retrieved dynamically.
 
 **Changed:**
 

diff --git a/news/import-package-dir.rst b/news/import-package-dir.rst
@@ -4,7 +4,7 @@
 
 **Changed:**
 
-* import package_dir_name in the `__init__.py` instead of `conda_pypi_package_dist_name` to ensure package import is lowercased
+* Import `package_dir_name`` in the `__init__.py` instead of `conda_pypi_package_dist_name` to ensure package import is lowercased.
 
 **Deprecated:**