Merge remote-tracking branch 'upstream/master' into drivendataorg-master

* upstream/master: (24 commits)
  Add poetry as an env manager (drivendataorg#460)
  Support pixi as environment manager (drivendataorg#459)
  Docs: Add guidelines for contributing and requesting tools (drivendataorg#456)
  Fix terminal animation generation in docs build (drivendataorg#451)
  Fix failing pipenv installation on Windows GH actions runners (drivendataorg#453)
  Fix typo in using-the-template.md (drivendataorg#448)
  Bump to v2.2.0 [skip ci]
  Update HISTORY.md [skip ci]
  Add option for tests (drivendataorg#447)
  Resolve python version to work with compatible operator (drivendataorg#446)
  Add pyproject.toml as a dependencies file option (drivendataorg#436)
  Make PyPI badges links to PyPI (drivendataorg#440)
  Update to version v2.1.0 (drivendataorg#438)
  Add back isort configuration that was removed in drivendataorg#387 (drivendataorg#439)
  add badges to readme and docs homepage (drivendataorg#434)
  Added support for the uv package and project manager (drivendataorg#408)
  Add ruff as default linting + formatting option (drivendataorg#387)
  Add PyTest IDs for better readability and filtering (drivendataorg#409)
  prepare for 2.0.1 release by bumping version in pyproject.toml and updating change log (drivendataorg#422)
  Fix pre-prompt ccds version error (drivendataorg#426)
  ...

Author: proinsias

.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: release
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    name: Build and publish new release
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev-requirements.txt
+
+      - name: Check that versions match
+        id: version
+        run: |
+          echo "Release tag: [${{ github.event.release.tag_name }}]"
+          PACKAGE_VERSION=$(python -c "import ccds; print(ccds.__version__)")
+          echo "Package version: [$PACKAGE_VERSION]"
+          [ ${{ github.event.release.tag_name }} == "v$PACKAGE_VERSION" ] || { exit 1; }
+          echo "::set-output name=major_minor_version::v${PACKAGE_VERSION%.*}"
+
+      - name: Build package
+        run: |
+          make dist
+          
+      - name: Publish to Test PyPI
+        uses: pypa/gh-action-pypi-publish@v1.3.0
+        with:
+          user: ${{ secrets.PYPI_TEST_USERNAME }}
+          password: ${{ secrets.PYPI_TEST_PASSWORD }}
+          repository_url: https://test.pypi.org/legacy/
+          skip_existing: true
+
+      - name: Publish to Production PyPI
+        uses: pypa/gh-action-pypi-publish@v1.3.0
+        with:
+          user: ${{ secrets.PYPI_PROD_USERNAME }}
+          password: ${{ secrets.PYPI_PROD_PASSWORD }}
+          skip_existing: false

.gitignore

@@ -133,6 +133,11 @@ ipython_config.py
 #   https://pdm.fming.dev/#use-with-ide
 .pdm.toml
 
+# pixi
+#   pixi.lock should be committed to version control for reproducibility
+#   .pixi/ contains the environments and should not be committed
+.pixi/
+
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
 

Makefile

@@ -22,7 +22,7 @@ create_environment:
 
 ## Install Python Dependencies
 requirements:
-	$(PYTHON_INTERPRETER) -m pip install -r dev-requirements.txt
+	$(PYTHON_INTERPRETER) -m pip install -U -r dev-requirements.txt
 
 # ## Format the code using isort and black
 # format:
@@ -34,6 +34,31 @@ requirements:
 # 	isort --check --profile black ccds hooks tests docs/scripts
 # 	black --check ccds hooks tests docs/scripts
 
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+	rm -fr .pytest_cache
+
+dist: clean ## builds source and wheel package
+	python -m build
+	ls -l dist
+
 
 ###     DOCS
 
@@ -46,7 +71,7 @@ docs-serve:
 ###     TESTS
 
 test: _prep
-	pytest -vvv --durations=0
+	pytest -vvv --durations=0 tests
 
 test-fastest: _prep
 	pytest -vvv -FFF

README.md

@@ -8,6 +8,7 @@ for setting up a data science project template that incorporates best practices.
 To learn more about CCDS's philosophy,
 visit the [project homepage](https://cookiecutter-data-science.drivendata.org/).
 
+
 This project also included code from
 [cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
 
@@ -75,3 +76,37 @@ The directory structure of your new project will look something like this (depen
     │
     └── plots.py                <- Code to create visualizations   
 ```
+
+## Using unreleased changes
+
+By default, `ccds` will use the _project template_ version that corresponds to the _installed `ccds` package_ version (e.g., if you have installed `ccds` v2.0.1, you'll use the v2.0.1 version of the project template by default). To use a specific version of the project template, use the `-c/--checkout` flag to provide the branch (or tag or commit hash) of the version you'd like to use. For example to use the project template from the `master` branch:
+
+```bash
+ccds -c master
+```
+
+## Using v1
+
+If you want to use the old v1 project template, you need to have either the cookiecutter-data-science package or cookiecutter package installed. Then, use either command-line program with the `-c v1` option:
+
+```bash
+ccds https://github.com/drivendataorg/cookiecutter-data-science -c v1
+# or equivalently
+cookiecutter https://github.com/drivendataorg/cookiecutter-data-science -c v1
+```
+
+## Contributing
+
+We welcome contributions! [See the docs for guidelines](https://cookiecutter-data-science.drivendata.org/contributing/).
+
+### Installing development requirements
+
+```bash
+pip install -r dev-requirements.txt
+```
+
+### Running the tests
+
+```bash
+pytest tests
+```

RELEASING.md

@@ -0,0 +1,16 @@
+# Information for releases and versioning of ccds
+
+## Background
+
+The release of [ccds v2](https://drivendata.co/blog/ccds-v2) introduced the `ccds` utility and the concept of versioning to cookiecutter data science. Prior to this release, cookiecutter-data-science only provided a project template, which the generic [cookiecutter](https://github.com/cookiecutter/cookiecutter) utility could use to instantiate a project. Branches and forks could be used in the usual way to get different versions of the template.
+
+To give the utility and the template a bit more stability, PR [#336](https://github.com/drivendataorg/cookiecutter-data-science/pull/336) created automated release mechanics for publishing new releases and, by default, pinned the template used by the `ccds` utility to the installed version. 
+
+## Issuing a new release
+
+ - [ ] Update version in `pyproject.toml` file
+ - [ ] Ensure `HISTORY.md` is up to date with the changes in this release and add version info and release date
+ - [ ] Create new release on the GitHub [releases page](https://github.com/drivendataorg/cookiecutter-data-science/releases) with the tag `vMAJOR.MINOR.PATCH` (e.g., `v2.3.0`) and the contents of the relevant `HISTORY.md` section as the release notes.
+ - [ ] Confirm release action runs successfully and the new release is available on [PyPI](https://pypi.org/project/cookiecutter-data-science/).
+
+`ccds` uses [semantic versioning](https://semver.org/). When issuing a new release, **ensure that your release version tag has the format `vMAJOR.MINOR.PATCH`. The `v` prefix is important because the utility will look for the tag with that name to download by default.

ccds-help.json

@@ -147,6 +147,27 @@
                     "more_information": "[Docs](https://docs.astral.sh/uv/)"
                 }
             },
+            {
+                "choice": "uv",
+                "help": {
+                    "description": "An extremely fast Python package and project manager, written in Rust.",
+                    "more_information": "[Docs](https://docs.astral.sh/uv/)"
+                }
+            },
+            {
+                "choice": "pixi",
+                "help": {
+                    "description": "A fast package manager built on top of the conda ecosystem with lock files for reproducible environments. Supports both pixi.toml and pyproject.toml. Requires pixi to be installed as a system binary (see docs for installation instructions).",
+                    "more_information": "[Docs](https://pixi.sh/)"
+                }
+            },
+            {
+                "choice": "poetry",
+                "help": {
+                    "description": "A dependency management and packaging tool for Python with lock files for reproducible environments. Uses pyproject.toml for configuration. Requires poetry to be installed as a system binary.",
+                    "more_information": "[Docs](https://python-poetry.org/docs/)"
+                }
+            },
             {
                 "choice": "none",
                 "help": {
@@ -166,8 +187,15 @@
             {
                 "choice": "requirements.txt",
                 "help": {
-                    "description": "Most general, least feature-rich format for use with `pip`.",
-                    "more_information": "[pip docs](https://pip.pypa.io/en/stable/reference/requirements-file-format/)"
+                    "description": "Classic format for a list of packages to be installed by `pip`.",
+                    "more_information": "[Docs](https://pip.pypa.io/en/stable/reference/requirements-file-format/)"
+                }
+            },
+            {
+                "choice": "pyproject.toml",
+                "help": {
+                    "description": "Modern configuration file for Python projects. Also supported by pixi when using tool.pixi sections.",
+                    "more_information": "[Docs](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/)"
                 }
             },
             {
@@ -183,6 +211,13 @@
                     "description": "Format used by Pipenv",
                     "more_information": "[Docs](https://pipenv.pypa.io/en/latest/pipfile.html)"
                 }
+            },
+            {
+                "choice": "pixi.toml",
+                "help": {
+                    "description": "Configuration file used by pixi for managing dependencies and environments.",
+                    "more_information": "[Docs](https://pixi.sh/latest/reference/pixi_manifest/)"
+                }
             }
         ]
     },
@@ -209,6 +244,59 @@
             }
         ]
     },
+    {
+        "field": "testing_framework",
+        "help": {
+            "description": "Framework used for testing your code.",
+            "more_information": ""
+        },
+        "choices": [
+            {
+                "choice": "none",
+                "help": {
+                    "description": "No testing framework.",
+                    "more_information": ""
+                }
+            },
+            {
+                "choice": "pytest",
+                "help": {
+                    "description": "Use the pytest framework for testing.",
+                    "more_information": "[Docs](https://docs.pytest.org/en/latest/)"
+                }
+            },
+            {
+                "choice": "unittest",
+                "help": {
+                    "description": "Use Python's built-in testing framework.",
+                    "more_information": "[Docs](https://docs.python.org/3/library/unittest.html)"
+                }
+            }
+        ]
+    },
+    {
+        "field": "linting_and_formatting",
+        "help": {
+            "description": "How to handle linting and formatting on your code.",
+            "more_information": ""
+        },
+        "choices": [
+            {
+                "choice": "ruff",
+                "help": {
+                    "description": "Use ruff for linting and formatting.",
+                    "more_information": ""
+                }
+            },
+            {
+                "choice": "flake8+black+isort",
+                "help": {
+                    "description": "Use flake8 for linting and black+isort for formatting.",
+                    "more_information": ""
+                }
+            }
+        ]
+    },
     {
         "field": "open_source_license",
         "help": {

ccds.json

@@ -16,17 +16,30 @@
         "conda",
         "pipenv",
         "uv",
+        "pixi",
+        "poetry",
         "none"
     ],
     "dependency_file": [
         "requirements.txt",
+        "pyproject.toml",
         "environment.yml",
-        "Pipfile"
+        "Pipfile",
+        "pixi.toml"
     ],
     "pydata_packages": [
         "none",
         "basic"
     ],
+    "testing_framework": [
+        "none",
+        "pytest",
+        "unittest"
+    ],
+    "linting_and_formatting": [
+        "ruff",
+        "flake8+black+isort"
+    ],
     "open_source_license": ["No license file", "MIT", "BSD-3-Clause"],
     "docs": ["mkdocs", "none"],
     "include_code_scaffold": ["Yes", "No"]

ccds/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("cookiecutter-data-science")

ccds/__main__.py

@@ -23,6 +23,8 @@
 from cookiecutter import cli
 from cookiecutter import main as api_main  # noqa: F401 referenced by tests
 
+from ccds import __version__
+
 
 def default_ccds_main(f):
     """Set the default for the cookiecutter template argument to the CCDS template."""
@@ -31,6 +33,11 @@ def _main(*args, **kwargs):
         f.params[1].default = (
             "https://github.com/drivendataorg/cookiecutter-data-science"
         )
+        # Find the "checkout" option in the cookiecutter cli (currently the fifth)
+        # Per #389, set this to the currently released version by default
+        param_names = [p.name for p in f.params]
+        checkout_index = param_names.index("checkout")
+        f.params[checkout_index].default = f"v{__version__}"
         return f(*args, **kwargs)
 
     return _main