Skip to content

Commit 2e99904

Browse files
committed
Fix: copy edits and links to our guide
1 parent ffd2612 commit 2e99904

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,17 @@ pyospackage is a demonstration Python package that compliments the pyOpenSci [be
1313

1414
## 🔧 About This Template
1515

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.
16+
This package was built using [pyOpenSci’s Python package Copier template](https://github.com/pyOpenSci/pyos-package-template).l This template makes it easy for anyone to quickly create a Python package following best practices developed by the pyOpenSci community.
1717

1818
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
19+
* [Standard Python package layout and structure](https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-structure.html)
20+
* [Code linting and formatting tools like Ruff](https://www.pyopensci.org/python-package-guide/package-structure-code/code-style-linting-format.html)
21+
* [Setup for a test suite](https://www.pyopensci.org/python-package-guide/tests/index.html)
22+
* [Basic setup for Continuous Integration and Deployment (CI/CD)](https://www.pyopensci.org/python-package-guide/continuous-integration/ci.html)
23+
* [Basic documentation infrastructure and files](https://www.pyopensci.org/python-package-guide/documentation/index.html) using mkdocs or sphinx
2424

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

27-
---
2827

2928
## 📘 Learn More About Python Packaging
3029

0 commit comments

Comments
 (0)