pyOpenSci Demo Python Package -- pyospackage

What does pyospackage do?

pyospackage is a demonstration Python package that compliments the pyOpenSci beginner tutorial series on creating a Python package.

Table of Contents

• Installation
• License

How to install

You can install this package using either pip or conda-forge. We recommend that you create a new Python environment to work in when installing this package. Use whatever environment manager that you wish!

To install the package using pip:

pip install pyospackage

To install the package using conda-forge:

conda install -c conda-forge pyospackage

Get started using packagename

To use this package:

from pyospackage.add_numbers import add_num


a = add_num(1, 2)
print(a)

You can also add any links to this section to tutorials in your documentation.

Development

• TODO: link to development docs when they exist and move the text below to the docs.

Linting & Code Formatting

TODO: this will be added to the docs once they are created in a separate pr.

All linting and code formatting is implemented in this package using a combination of pre-commit hooks and Ruff. Ruff is a fast, rust-based linter and code formatter that covers functionality previously implemented by Black and isort (formatters that are commonly used in the Python ecosystem). Ruff simplifies your linting and code format setup but running all of the checks and fixes using a single tool. As such pyOpenSci encourages new projects to consider using Ruff.

Community

Information here about contributing to your package. links to your code of conduct and development guide.

How to cite pyospackage

To cite pyospackage please follow the citation instructions on Zenodo.

Leah Wasser. (2024). pyOpenSci/pyosPackage: v0.1 Test release (v0.1.0). Zenodo. https://doi.org/10.5281/zenodo.10594121

License

pyospackage is distributed under the terms of the MIT license.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Alex Batisse 👀

Jonny Saunders 💻 👀

Sarah Kaiser 💻 👀

Geoff Cureton 💻 👀

Steven Silvester 💻 👀

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