A package that adds numbers together.
Project description
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.
🔧 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:
- Standard Python package layout and structure
- Code linting and formatting tools like Ruff
- Setup for a test suite
- Basic setup for Continuous Integration and Deployment (CI/CD)
- Basic documentation infrastructure and files using mkdocs or sphinx
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:
- 📦 Tutorial Series: Beginner Python Packaging Tutorials
- 📖 Overview: Python Packaging Overview
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
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 👀 |
Jonny Saunders 💻 👀 |
Sarah Kaiser 💻 👀 |
Geoff Cureton 💻 👀 |
Steven Silvester 💻 👀 |
James Lamb 💻 👀 📖 |
steven 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
520f8869796bde7ebbbe5c8bc6ca810eab20a010b50b78f260fa440594bcf2d1
|
|
| MD5 |
c9758d9e58cbe6d9b84134bf24b7d71e
|
|
| BLAKE2b-256 |
ccb5aa7e87f8769d960154f2c6309155f0550a7b87e659a6286c0c6971005263
|
Provenance
The following attestation bundles were made for pyospackage-0.5.tar.gz:
Publisher:
build-publish-pypi.yml on pyOpenSci/pyosPackage
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyospackage-0.5.tar.gz -
Subject digest:
520f8869796bde7ebbbe5c8bc6ca810eab20a010b50b78f260fa440594bcf2d1 - Sigstore transparency entry: 676790889
- Sigstore integration time:
-
Permalink:
pyOpenSci/pyosPackage@5a1754fe925a0dddbd6a3c779417783c649d3747 -
Branch / Tag:
refs/tags/v0.5 - Owner: https://github.com/pyOpenSci
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-publish-pypi.yml@5a1754fe925a0dddbd6a3c779417783c649d3747 -
Trigger Event:
release
-
Statement type:
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c3606924cd8e643f4ad7e4e1ac01f45892e7dab100ae60306ddf908a25349a3b
|
|
| MD5 |
cc2283db434ee99382008f3c50bf4b4f
|
|
| BLAKE2b-256 |
f1e08a109af3db60bce43a3de11005f2d5d7d6ef002cb27e9371a93ccd7d036a
|
Provenance
The following attestation bundles were made for pyospackage-0.5-py3-none-any.whl:
Publisher:
build-publish-pypi.yml on pyOpenSci/pyosPackage
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyospackage-0.5-py3-none-any.whl -
Subject digest:
c3606924cd8e643f4ad7e4e1ac01f45892e7dab100ae60306ddf908a25349a3b - Sigstore transparency entry: 676790891
- Sigstore integration time:
-
Permalink:
pyOpenSci/pyosPackage@5a1754fe925a0dddbd6a3c779417783c649d3747 -
Branch / Tag:
refs/tags/v0.5 - Owner: https://github.com/pyOpenSci
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-publish-pypi.yml@5a1754fe925a0dddbd6a3c779417783c649d3747 -
Trigger Event:
release
-
Statement type: