package-helper-3
Science Score: 44.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
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.7%) to scientific vocabulary
Keywords
Repository
Basic Info
Statistics
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 10
Topics
Metadata Files
README.md
Package Helper 3
Package Helper 3 helps to create, develop and maintain a Python package.
It is a fork/mix of https://github.com/audreyr/cookiecutter-pypackage/, https://github.com/francois-durand/packagehelper2/, and https://github.com/fpgmaas/cookiecutter-poetry.
The most prominent feature of Package Helper 3 is a tutorial that gives a checklist of how to:
- Create your package in a few minutes with Cookiecutter and UV,
- Develop and maintain your package with PyCharm,
- Host your package on GitHub and leverage GitHub actions,
- Publish your package on PyPi,
- Publicly share your coverage on Codecov.
A simple Command-Line Interface initiates the creation of the package using a template of Python package. Here are the main features of the template:
- Default options that can be personalized.
- Include example files for classes, with examples of documentation and testing.
- Use UV for all-in-one management of dependencies and settings.
Documentation:
- Use GitHub actions and GitHub Pages to publish the documentation.
- Use
sphinx.ext.napoleonto benefit from NumPy style of documentation. - Use PyData theme.
- Add a "reference" section in the documentation of the package.
Use GitHub actions to perform unit tests.
Use GitHub actions to deploy the package on PyPI.
Generate a local html page displaying the test coverage.
Use Codecov for getting a public badge of your test coverage.
Documentation: https://balouf.github.io/package-helper-3/.
Owner
- Name: Fabien Mathieu
- Login: balouf
- Kind: user
- Location: Paris, France
- Company: LINCS
- Website: https://www.lincs.fr/people/fabien-mathieu/
- Repositories: 6
- Profile: https://github.com/balouf
Researcher at Lincs
Citation (CITATION.cff)
cff-version: 1.2.0
title: Package Helper 3
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- family-names: Mathieu
given-names: Fabien
email: fabien.mathieu@normalesup.org
repository-code: "https://github.com/balouf/package-helper-3/"
url: "https://balouf.github.io/package-helper-3/"
abstract: Package Helper 3 helps to create, develop, and maintain a Python package with UV.
license: MIT
GitHub Events
Total
- Release event: 4
- Push event: 29
- Create event: 5
Last Year
- Release event: 4
- Push event: 29
- Create event: 5
Packages
- Total packages: 1
-
Total downloads:
- pypi 126 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 10
- Total maintainers: 1
pypi.org: package-helper-3
Package Helper 3 helps to create, develop, and maintain a Python package with UV.
- Documentation: https://package-helper-3.readthedocs.io/
-
Latest release: 0.4.5
published 8 months ago