An open API service indexing awesome lists of open source software.

https://github.com/seedcase-project/template-python-package

A template repository to use when making a Python package for Seedcase.
https://github.com/seedcase-project/template-python-package

copier-python copier-template template-package template-python template-python-package template-repository-python

Last synced: 5 days ago
JSON representation

A template repository to use when making a Python package for Seedcase.

Awesome Lists containing this project

README

          

# Template Python Package: An opinionated setup for making Python packages

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17018496.svg)](https://doi.org/10.5281/zenodo.17018496)
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)
[![GitHub
License](https://img.shields.io/github/license/seedcase-project/template-python-package.svg)](https://github.com/seedcase-project/template-python-package/blob/main/LICENSE.md)
[![GitHub
Release](https://img.shields.io/github/v/release/seedcase-project/template-python-package.svg)](https://github.com/seedcase-project/template-python-package/releases/latest)
[![Test](https://github.com/seedcase-project/template-python-package/actions/workflows/test.yml/badge.svg)](https://github.com/seedcase-project/template-python-package/actions/workflows/test.yml)
[![Build
website](https://github.com/seedcase-project/template-python-package/actions/workflows/build-website.yml/badge.svg)](https://github.com/seedcase-project/template-python-package/actions/workflows/build-website.yml)
[![CodeQL](https://github.com/seedcase-project/template-python-package/actions/workflows/github-code-scanning/codeql/badge.svg?branch=main)](https://github.com/seedcase-project/template-python-package/actions/workflows/github-code-scanning/codeql)
[![pre-commit.ci
status](https://results.pre-commit.ci/badge/github/seedcase-project/template-python-package/main.svg)](https://results.pre-commit.ci/latest/github/seedcase-project/template-python-package/main)
[![lifecycle](https://lifecycle.r-lib.org/articles/figures/lifecycle-experimental.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Project Status: Active – The project has reached a stable, usable
state and is being actively
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

This repository contains a [copier](https://copier.readthedocs.io/)
template for setting up a new repository for a Python package. Along
with a structured directory layout, this template includes
configurations for tools that improve developer experience, continuous
integration and delivery workflows, and supporting files for building
robust Python packages.

Check out our
[website](https://template-python-package.seedcase-project.org/) for
more information, such as the features it provides and a
[guide](https://template-python-package.seedcase-project.org/docs/guide/)
to using the template. For a list of changes, see our
[changelog](https://template-python-package.seedcase-project.org/docs/releases/)
page.

## Contributing

Check out our [contributing
page](https://template-python-package.seedcase-project.org/contributing/)
for information on how to contribute to the project, including how to
set up your development environment.

Please note that this project is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
to abide by its terms.

### Contributors

The following people have contributed to this project by submitting pull
requests :tada:

[@lwjohnst86](https://github.com/lwjohnst86),
[@martonvago](https://github.com/martonvago),
[@signekb](https://github.com/signekb)

## Licensing

This project is licensed under the [MIT License](LICENSE.md).

## Citing

This project is part of the Seedcase Project, which is a collaborative
effort to create a framework for data management and analysis in
research. If you use this project in your work, please cite it as
follows:

Johnston L.W., Brødbæk S.K., Beicher K., Vago M. (2025). Template Python
Package: An opinionated setup for making Python packages DOI:
10.5281/zenodo.17018496 URL:
https://template-python-package.seedcase-project.org

Or as a BibTeX entry:

@misc{YourReferenceHere,
author = {Johnston, Luke William and Brødbæk, Signe Kirk and Beicher, Kristiane and Vago, Marton},
doi = {10.5281/zenodo.17018496},
month = {9},
title = {Template Python Package: An opinionated setup for making Python packages},
url = {https://template-python-package.seedcase-project.org},
year = {2025}
}