Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/12rambau/pypackage

The skeleton of a python package

https://github.com/12rambau/pypackage

Science Score: 26.0%

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

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.4%) to scientific vocabulary

Keywords

copier copier-template package python
Last synced: 6 months ago · JSON representation

Repository

The skeleton of a python package

Basic Info
Statistics
  • Stars: 7
  • Watchers: 2
  • Forks: 1
  • Open Issues: 3
  • Releases: 26
Topics
copier copier-template package python
Created about 4 years ago · Last pushed 8 months ago
Metadata Files
Readme License

README.rst 

Pypackage
=========

.. |release| image:: https://img.shields.io/github/v/release/12rambau/pypackage?logo=github&logoColor=white
   :alt: GitHub release (with filter)
   :target: https://github.com/12rambau/pypackage/releases

.. |workflow| image:: https://img.shields.io/github/actions/workflow/status/12rambau/pypackage/unit.yaml?logo=github&logoColor=white
   :alt: GitHub Workflow Status (with event)
   :target: https://github.com/12rambau/pypackage/actions/workflows/unit.yaml

.. |docs| image:: https://img.shields.io/readthedocs/12rambau-pypackage?logo=readthedocs&logoColor=white
   :alt: Read the Docs
   :target: https://app.readthedocs.org/projects/12rambau-pypackage/

|release| |workflow| |docs|

The skeleton of a python lib embedding what I like:

- pre-commit hooks (`prettier `__, `ruff `__, `black `__)
- `uv `__ backed nox unit tests (doc, `pytest `__, `mypy `__)
- a documentation structure based on `Sphinx `__ using the `pydata-sphinx-theme `__
- a complete github folder (README, LICENSE, etc...)
- an automated citation file
- github actions (test, coverage, mypy, lint)
- ready to publish on `pipy `__
- ready to publish on `readthedocs `__
- ready to link to `codecov `__

Usage
-----

Follow the instructions from the `online documentation `__

Demonstration
-------------

The package end result is demonstrated in the `pypackage-skeleton `__ repository.

Owner

  • Name: Rambaud Pierrick
  • Login: 12rambau
  • Kind: user
  • Location: Rome, Italy
  • Company: FAO @openforis

Materials engineer turned Software Engineer and Python enthusiast for Earth Observation applications

GitHub Events

Total
  • Create event: 20
  • Release event: 4
  • Issues event: 16
  • Watch event: 2
  • Delete event: 17
  • Issue comment event: 4
  • Push event: 42
  • Pull request event: 33
  • Fork event: 1
Last Year
  • Create event: 20
  • Release event: 4
  • Issues event: 16
  • Watch event: 2
  • Delete event: 17
  • Issue comment event: 4
  • Push event: 42
  • Pull request event: 33
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 56
  • Total pull requests: 71
  • Average time to close issues: 29 days
  • Average time to close pull requests: 2 days
  • Total issue authors: 4
  • Total pull request authors: 1
  • Average comments per issue: 0.21
  • Average comments per pull request: 0.0
  • Merged pull requests: 69
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 8
  • Pull requests: 16
  • Average time to close issues: 18 days
  • Average time to close pull requests: 4 days
  • Issue authors: 3
  • Pull request authors: 1
  • Average comments per issue: 0.63
  • Average comments per pull request: 0.0
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • 12rambau (51)
  • framunoz (1)
  • dfguerrerom (1)
  • fitoprincipe (1)
Pull Request Authors
  • 12rambau (92)
Top Labels
Issue Labels
wontfix (1)
Pull Request Labels

Dependencies

.github/workflows/unit.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
{{cookiecutter.github_repo_name}}/pyproject.toml pypi
  • deprecated >=1.2.14
{{cookiecutter.github_repo_name}}/setup.py pypi