Skip to content

Commit ffd2612

Browse files
Steven Hinojosalwasser
authored andcommitted
docs: Add template info and packaging tutorial links to README
- Add section about pyOpenSci Copier template with features overview - Add section with links to Python packaging tutorials and documentation - Improve discoverability of pyOpenSci educational resources
1 parent 3cb1917 commit ffd2612

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,30 @@
1111
## What does pyospackage do?
1212
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).
1313

14+
## 🔧 About This Template
15+
16+
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.
17+
18+
The template includes configuration for:
19+
- Standard Python packaging layout
20+
- Code linting and formatting tools like Ruff
21+
- Testing setup
22+
- CI/CD scaffolding
23+
- Contribution guidelines
24+
25+
If you're interested in using the template, check out the [Copier Template Repo](https://github.com/pyOpenSci/pyos-template).
26+
27+
---
28+
29+
## 📘 Learn More About Python Packaging
30+
31+
This package accompanies our tutorials and docs on building and publishing high-quality Python packages:
32+
33+
- 📦 **Tutorial Series:** [Beginner Python Packaging Tutorials](https://www.pyopensci.org/python-package-guide/tutorials/index.html)
34+
- 📖 **Overview:** [Python Packaging Overview](https://www.pyopensci.org/python-package-guide/overview.html)
35+
36+
These resources cover everything from package layout and versioning to testing, publishing to PyPI, and creating great documentation.
37+
1438
**Table of Contents**
1539

1640
- [Installation](#installation)

0 commit comments

Comments
 (0)