pyospackage

An example package that compliments our package guide & tutorials.

https://github.com/pyopensci/pyospackage

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 6 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.7%) to scientific vocabulary

Keywords

open-source openscience pyopensci python

Last synced: 6 months ago · JSON representation ·

Repository

An example package that compliments our package guide & tutorials.

Basic Info

Host: GitHub
Owner: pyOpenSci
License: mit
Language: Python
Default Branch: main
Homepage: https://pyospackage.readthedocs.io/en/latest/
Size: 118 KB

Statistics

Stars: 3
Watchers: 6
Forks: 6
Open Issues: 5
Releases: 7

Topics

open-source openscience pyopensci python

Created over 2 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog License Code of conduct Citation

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.

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:

shell pip install pyospackage

To install the package using conda-forge:

shell conda install -c conda-forge pyospackage

Get started using packagename

To use this package:

```python from pyospackage.addnumbers import addnum

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.

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!

Owner

Name: pyOpenSci
Login: pyOpenSci
Kind: organization

Website: www.pyopensci.org
Twitter: pyOpenSci
Repositories: 7
Profile: https://github.com/pyOpenSci

We build diverse community around the tools that drive open science through open peer review, mentorship and training.

Citation (CITATION.cff)

cff-version: 1.2.0
title: pyospackage
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Leah
    family-names: Wasser
    email: leah@pyopensci.org
    affiliation: pyOPenSci
    orcid: 'https://orcid.org/0000-0002-8177-6550'
  - name: pyOpenSci
    location: Boulder
    region: Colorado
    email: pyopensci@pyopensci.org
identifiers:
  - type: doi
    value: 10.5281/zenodo.10594120
    description: Citation information from Zenodo
repository-code: 'https://www.github.com/pyopensci/pyospackage'
url: 'https://www.pyopensci.org'
abstract: >-
  An example Python package used in pyOpenSci training
  events and tutorials.
keywords:
  - openscience
  - python
  - opensource
  - science
license: BSD-3-Clause

GitHub Events

Total

Create event: 10
Issues event: 4
Release event: 2
Watch event: 1
Delete event: 5
Issue comment event: 26
Push event: 31
Pull request review comment event: 5
Pull request review event: 8
Pull request event: 24
Fork event: 2

Last Year

Create event: 10
Issues event: 4
Release event: 2
Watch event: 1
Delete event: 5
Issue comment event: 26
Push event: 31
Pull request review comment event: 5
Pull request review event: 8
Pull request event: 24
Fork event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 3
Total pull requests: 7
Average time to close issues: about 1 year
Average time to close pull requests: 5 days
Total issue authors: 1
Total pull request authors: 4
Average comments per issue: 0.0
Average comments per pull request: 0.71
Merged pull requests: 7
Bot issues: 0
Bot pull requests: 5

Past Year

Issues: 2
Pull requests: 7
Average time to close issues: N/A
Average time to close pull requests: 5 days
Issue authors: 1
Pull request authors: 4
Average comments per issue: 0.0
Average comments per pull request: 0.71
Merged pull requests: 7
Bot issues: 0
Bot pull requests: 5

View more stats

Top Authors

Issue Authors

lwasser (9)

Pull Request Authors

lwasser (22)
pre-commit-ci[bot] (12)
allcontributors[bot] (5)
crazy4pi314 (1)
gpcureton (1)
sneakers-the-rat (1)
jameslamb (1)
stevenrayhinojosa-gmail-com (1)

Top Labels

Issue Labels

help wanted (2)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 58 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 10
Total maintainers: 1

pypi.org: pyospackage

A package that adds numbers together

Homepage: https://pypi.org/project/pyospackage/
Documentation: https://pyospackage.readthedocs.io/en/latest/
License: mit
Latest release: 0.1.12
published over 1 year ago

Versions: 10
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 58 Last month

Rankings

Dependent packages count: 10.0%

Average: 37.8%

Dependent repos count: 65.7%

Maintainers (1)

lwasser