Ferret 🦡
Framework for Enhance: Organized Workflow Library Ferret is a Python tool designed specifically to create 'enhance.pet' compliant Python packages. This tool offers a user-friendly way to generate a package structure that follows the guidelines and best practices of the enhance.pet framework.
Features 🌟
- 'enhance.pet' Compliance: Designed to generate package structures that are fully compliant with the enhance.pet framework.
- Interactive CLI: Offers an interactive command-line interface.
- Customization: Allows package name, author, and location to be user-defined.
- Code Structure: Automatically generates necessary files and directories.
- Template Preambles: Adds Sphinx-compatible documentation templates to Python modules.
Installation 🛠️
To install Ferretz, run:
pip install ferretz
Usage 🚀
After installation, start Ferretz using the CLI:
ferretz
Follow the on-screen instructions to create your enhance.pet compliant Python package.
Directory Structure
Generated package structure will be fully compliant with enhance.pet guidelines:
your_package_namez/
├── your_package_namez/
│ ├── __init__.py
│ └── [other_modules].py
├── README.md
└── setup.py
Contributing 🤝
Contributions, issues, and feature requests are welcome!
License 📄
Licensed under the MIT License - see the LICENSE.md file for details.
1 maintainer
Metadata
1 maintainer
Release files for ferretz 0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ferretz-0.3.tar.gz | 5.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ferretz-0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 11.8 kB
Release files / ferretz-0.3.tar.gz
| Download URL | ferretz-0.3.tar.gz |
|---|---|
| Size | 5.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
571b667a35651030927804ed4e381ded66d5f13fea9b8ae0baa91922bd871962
|
|
BLAKE2b-256 checksum How to use checksums |
5520e08a80a92a7763d380a17888cf663cc3173fb604b0a44d098d6f318ff949
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Release files / ferretz-0.3-py3-none-any.whl
| Download URL | ferretz-0.3-py3-none-any.whl |
|---|---|
| Size | 6.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
04b76ea1aca7d9bd6cffcfa718f0d842c7cb41068d796a8a703f6c0e553de849
|
|
BLAKE2b-256 checksum How to use checksums |
b2ff5ffb4b79ed00be52fc8162166a2751ea8b036f581853efe7cda744a9b7bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Security for ferretz 0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
