pyOpenSci Package Template

A Python package template that supports the pyOpenSci pure Python packaging tutorial.

This template can be used with copier to initialize a new Python package project structure following the practices outlined in the pyOpenSci tutorial.

Getting Started

To use this template:

1. Install copier using pipx or pip preferably with a virtual environment.

   pipx install copier

   or

   pip install copier

2. Run the below copier command. Please note that copier creates a target directory if it doesn't exist yet. It will also create and possibly overwrite files in the given directory, even if it already exists! That includes your current directory if that is your target.

   copier copy gh:pyopensci/pyos-package-template <target>

   Where <target> could be your current directory . or some other path.

   Used in the above way, copier will use the latest tagged release, which is probably the safest option. You can provide an option --vcs-ref to choose specific branches as your source. You can read more about generating your project in the copier documentation.

Staying Up-to-date

The community will likely continue to develop this template. If at any point, you want to adopt those changes for your project, you can update it. Read more about that process in the copier documentation.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Moritz E. Beber 💻 👀 🤔

Steven Silvester 💻 👀 🤔

Jonny Saunders 💻 👀

Jeremy Paige 💻 👀

Leah Wasser 💻 👀

This project follows the all-contributors specification. Contributions of any kind welcome!