Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,30 @@ 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/en/stable/) 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.
[Copier](https://copier.readthedocs.io/en/stable/) template for setting
up a new repository for a Python package. We made this template because
we manage and develop several Python packages in Seedcase, and this
template is designed to make it easier to create, develop, and maintain
those 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/changelog.html)
page.
[changelog](CHANGELOG.md) page.

> [!TIP]
>
> This template repository was generated from the
> [t-squared](https://github.com/seedcase-project/t-squared) Seedcase
> template :tada:

## 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.
Check out our [contributing page](CONTRIBUTING.md) 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
Expand All @@ -50,21 +54,18 @@ to abide by its terms.
The following people have contributed to this project by submitting pull
requests :tada:

[@joelostblom](https://github.com/joelostblom),
[@lwjohnst86](https://github.com/lwjohnst86),
[@martonvago](https://github.com/martonvago),
[@signekb](https://github.com/signekb),
[@joelostblom](https://github.com/joelostblom)
[@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:
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:
Expand Down
33 changes: 17 additions & 16 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,37 @@
format: gfm
execute:
echo: false
jupyter: python3
metadata-files:
- _metadata.yml
---

# {{< meta titles.full >}}
# {{< meta tagline >}}

{{< include /docs/includes/_badges.qmd >}}

This repository contains a
[copier](https://copier.readthedocs.io/en/stable/) 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.
[Copier](https://copier.readthedocs.io/en/stable/) template for setting
up a new repository for a Python package. We made this template because
we manage and develop several Python packages in Seedcase, and this
template is designed to make it easier to create, develop, and maintain
those Python packages.

Check out our [website]({{< meta links.site >}}) for more information,
such as the features it provides and a
[guide]({{< meta links.site >}}/docs/guide) to using the template. For a
list of changes, see our
[changelog]({{< meta links.site >}}/changelog.html) page.
list of changes, see our [changelog](CHANGELOG.md) page.

::: callout-tip
This template repository was generated from the
[t-squared](https://github.com/seedcase-project/t-squared) Seedcase
template :tada:
:::

## Contributing

Check out our [contributing page]({{< meta links.site >}}/contributing)
for information on how to contribute to the project, including how to
set up your development environment.
Check out our [contributing page](CONTRIBUTING.md) 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
Expand All @@ -44,10 +48,7 @@ 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:
If you use this project in your work, please cite it as follows:

```{python}
#| output: asis
Expand Down
5 changes: 1 addition & 4 deletions _metadata.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# Metadata for the website
gh:
org: "seedcase-project"
repo: "template-python-package"

titles:
full: "Template Python Package: An opinionated setup for making Python packages"
short: "Template Python Package"
tagline: "Template Python Package: An opinionated setup for making Python packages"

links:
github: "https://github.com/seedcase-project/template-python-package"
Expand Down
Loading