Skip to main content

A package that adds numbers together.

Project description

pyOpenSci Demo Python Package -- pyospackage

All Contributors

PyPI - Version PyPI - Python Version

DOI

What does pyospackage do?

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

🔧 About This Template

This package was built using pyOpenSci’s Python package Copier template.l This template makes it easy for anyone to quickly create a Python package following best practices developed by the pyOpenSci community.

The template includes configuration for:

If you're interested in using the template, check out the Copier Template Repo.

📘 Learn More About Python Packaging

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

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

How to install

You can install this package using either pip, uv, 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

To install the package using uv:

uv pip install pyospackage

Or just run uv run python in the directory where the package lives and it will install it automatically into the chosen uv venv.

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

Development documentation can be found in the DEVELOPMENT.md file.

Linting & Code Formatting

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

DOI

To cite pyospackage please follow the citation instructions on Zenodo.

License

pyospackage is distributed under the terms of the MIT license.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Alex Batisse
Alex Batisse

👀
Jonny Saunders
Jonny Saunders

💻 👀
Sarah Kaiser
Sarah Kaiser

💻 👀
Geoff Cureton
Geoff Cureton

💻 👀
Steven Silvester
Steven Silvester

💻 👀
James Lamb
James Lamb

💻 👀 📖
steven
steven

📖

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyospackage-0.5.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyospackage-0.5-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file pyospackage-0.5.tar.gz.

File metadata

  • Download URL: pyospackage-0.5.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyospackage-0.5.tar.gz
Algorithm Hash digest
SHA256 520f8869796bde7ebbbe5c8bc6ca810eab20a010b50b78f260fa440594bcf2d1
MD5 c9758d9e58cbe6d9b84134bf24b7d71e
BLAKE2b-256 ccb5aa7e87f8769d960154f2c6309155f0550a7b87e659a6286c0c6971005263

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyospackage-0.5.tar.gz:

Publisher: build-publish-pypi.yml on pyOpenSci/pyosPackage

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyospackage-0.5-py3-none-any.whl.

File metadata

  • Download URL: pyospackage-0.5-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyospackage-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c3606924cd8e643f4ad7e4e1ac01f45892e7dab100ae60306ddf908a25349a3b
MD5 cc2283db434ee99382008f3c50bf4b4f
BLAKE2b-256 f1e08a109af3db60bce43a3de11005f2d5d7d6ef002cb27e9371a93ccd7d036a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyospackage-0.5-py3-none-any.whl:

Publisher: build-publish-pypi.yml on pyOpenSci/pyosPackage

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page