Skip to content

docs: Add template info and packaging tutorial links to README #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,30 @@
## What does pyospackage do?
pyospackage is a demonstration Python package that compliments the pyOpenSci [beginner tutorial series on creating a Python package](https://www.pyopensci.org/python-package-guide/tutorials/intro.html).

## 🔧 About This Template

This package was built using [pyOpenSci’s Copier template](https://github.com/pyOpenSci/pyos-template), which helps ensure consistency, best practices, and ease of maintenance across scientific Python packages.

The template includes configuration for:
- Standard Python packaging layout
- Code linting and formatting tools like Ruff
- Testing setup
- CI/CD scaffolding
- Contribution guidelines

If you're interested in using the template, check out the [Copier Template Repo](https://github.com/pyOpenSci/pyos-template).

---

## 📘 Learn More About Python Packaging

This package accompanies our tutorials and docs on building and publishing high-quality Python packages:

- 📦 **Tutorial Series:** [Beginner Python Packaging Tutorials](https://www.pyopensci.org/python-package-guide/tutorials/index.html)
- 📖 **Overview:** [Python Packaging Overview](https://www.pyopensci.org/python-package-guide/overview.html)

These resources cover everything from package layout and versioning to testing, publishing to PyPI, and creating great documentation.

**Table of Contents**

- [Installation](#installation)
Expand Down