https://github.com/eckelsjd/copier-numpy

Template for a numpy-based scientific computing Python package.
https://github.com/eckelsjd/copier-numpy

copier-template numpy pdm python

Last synced: 3 months ago
JSON representation

Template for a numpy-based scientific computing Python package.

• Host: GitHub
• URL: https://github.com/eckelsjd/copier-numpy
• Owner: eckelsjd
• License: mit
• Created: 2024-08-23T20:19:54.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-07-25T21:43:17.000Z (11 months ago)
• Last Synced: 2025-07-26T04:47:36.517Z (11 months ago)
• Topics: copier-template, numpy, pdm, python
• Language: Jinja
• Homepage:
• Size: 105 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Numpy project template

[![Python 3.11](https://img.shields.io/badge/python-3.11+-blue.svg?logo=python&logoColor=cccccc)](https://www.python.org/downloads/) 

[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://squidfunk.github.io/mkdocs-material/)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

![Code Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?logo=codecov)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)

Construct a `numpy`-based Python project from scratch for scientific computing and research.

## :wrench: Features

- [Numpy](https://numpy.org/) a basic installation for the holy trifecta :dove: of `numpy, matplotlib, scipy`.

- [pdm](https://pdm-project.org) or [uv](https://docs.astral.sh/uv/) for dependency, virtualenv, and package management.

- [Mkdocs material](https://squidfunk.github.io/mkdocs-material/) for simple, clean, automated, online code documentation.

- [pre-commit](https://github.com/pre-commit/pre-commit) with [ruff](https://github.com/astral-sh/ruff) integration for code linting and formatting.

- [pytest](https://docs.pytest.org/en/stable/index.html#) with [coverage](https://pytest-cov.readthedocs.io/en/latest/) for regression testing and code coverage.

- [Commitizen](https://github.com/commitizen-tools/commitizen) with [conventional commits](https://conventionalcommits.org) for automatic versioning and changelogs.

- [Copier](https://github.com/copier-org/copier) for continuously updating project from this original template.

- [Github actions](https://docs.github.com/en/actions) for automated, build, test, and deployment.

## :round_pushpin: Quickstart

Install copier with extensions-

```shell

pdm self add copier copier-templates-extensions            # pdm, or

uv tool install copier --with copier-templates-extensions  # uv

```

Then copy the template-

```shell

copier copy gh:eckelsjd/copier-numpy  --trust

```

That's it! Follow the questionnaire and then your `numpy`-based scientific computing project is ready to go.

***Note:*** The `--trust` flag enables extensions used in this template. Please see [extensions.py](extensions.py) and [setup_github.py](setup_github.py) to make sure you trust this template (*spoiler:* these just add some global template variables and some basic `git` scripting).

## :snake: Publishing on PyPI

Follow [this tutorial](https://docs.pypi.org/trusted-publishers/) to enable trusted publishing with Github actions. Then, do:

```shell

cz bump

```

That's it! Your package will automatically deploy to PyPI and GitHub with a correctly-versioned `vX.X.X` tag.

## :arrows_counterclockwise: Updating your project

```shell

copier update --trust

```

This will update template files in your project with the most recent releases to the `copier-numpy` template. See the [copier docs](https://copier.readthedocs.io/en/stable/updating/) for more info.

## :link: See similar

- [Scientific Python library development](https://github.com/scientific-python/cookie)

- [Copier-pdm](https://github.com/pawamoy/copier-pdm) and the similar [pdm-project](https://github.com/pdm-project/copier-pdm) version

- [Serious scaffolding](https://github.com/serious-scaffold/ss-python) for Python projects

- [LINCC framework](https://github.com/lincc-frameworks/python-project-template) for Python projects by the University of Washington

- [copier-pylib](https://github.com/astrojuanlu/copier-pylib) for pure Python projects