<p align="center">
<img src="https://github.com/LalithShiyam/FERRET/blob/main/Images/Ferret-logo.png">
</p>
# Ferret 🦡
[](https://pypi.org/project/ferretz/) [&color=FF69B4&style=flat-square&logo=python)](https://pypi.org/project/ferretz/)
[&color=FF69B4&style=flat-square&logo=python)](https://pypi.org/project/ferretz/)
**_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:
```bash
pip install ferretz
```
## Usage 🚀
After installation, start Ferretz using the CLI:
```bash
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:
```plaintext
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](./LICENSE) - see the [LICENSE.md](./LICENSE.md) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/LalithShiyam/ferretz",
"name": "ferretz",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "enhance.pet,package creation,Python",
"author": "Lalith Kumar Shiyam Sundar",
"author_email": "lalith.shiyamsundar@meduniwien.ac.at",
"download_url": "https://files.pythonhosted.org/packages/55/20/e08a80a92a7763d380a17888cf663cc3173fb604b0a44d098d6f318ff949/ferretz-0.3.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n<img src=\"https://github.com/LalithShiyam/FERRET/blob/main/Images/Ferret-logo.png\">\n</p>\n\n# Ferret \ud83e\udda1 \n[](https://pypi.org/project/ferretz/) [&color=FF69B4&style=flat-square&logo=python)](https://pypi.org/project/ferretz/) \n[&color=FF69B4&style=flat-square&logo=python)](https://pypi.org/project/ferretz/)\n\n\n**_Framework for Enhance: Organized Workflow Library_**\nFerret 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.\n\n## Features \ud83c\udf1f\n\n- **'enhance.pet' Compliance**: Designed to generate package structures that are fully compliant with the enhance.pet framework.\n- **Interactive CLI**: Offers an interactive command-line interface.\n- **Customization**: Allows package name, author, and location to be user-defined.\n- **Code Structure**: Automatically generates necessary files and directories.\n- **Template Preambles**: Adds Sphinx-compatible documentation templates to Python modules.\n\n## Installation \ud83d\udee0\ufe0f\n\nTo install Ferretz, run:\n\n```bash\npip install ferretz\n```\n\n## Usage \ud83d\ude80\n\nAfter installation, start Ferretz using the CLI:\n\n```bash\nferretz\n```\n\nFollow the on-screen instructions to create your enhance.pet compliant Python package.\n\n### Directory Structure\n\nGenerated package structure will be fully compliant with enhance.pet guidelines:\n\n```plaintext\nyour_package_namez/\n\u251c\u2500\u2500 your_package_namez/\n\u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u2514\u2500\u2500 [other_modules].py\n\u251c\u2500\u2500 README.md\n\u2514\u2500\u2500 setup.py\n```\n\n## Contributing \ud83e\udd1d\n\nContributions, issues, and feature requests are welcome!\n\n## License \ud83d\udcc4\n\nLicensed under the [MIT License](./LICENSE) - see the [LICENSE.md](./LICENSE.md) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python package to create \"enhance.pet\" compliant package folder structures",
"version": "0.3",
"project_urls": {
"Homepage": "https://github.com/LalithShiyam/ferretz"
},
"split_keywords": [
"enhance.pet",
"package creation",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2ff5ffb4b79ed00be52fc8162166a2751ea8b036f581853efe7cda744a9b7bd",
"md5": "f56410bdb5d849a7729c03ac88e7017b",
"sha256": "04b76ea1aca7d9bd6cffcfa718f0d842c7cb41068d796a8a703f6c0e553de849"
},
"downloads": -1,
"filename": "ferretz-0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f56410bdb5d849a7729c03ac88e7017b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6290,
"upload_time": "2023-10-03T17:51:22",
"upload_time_iso_8601": "2023-10-03T17:51:22.492435Z",
"url": "https://files.pythonhosted.org/packages/b2/ff/5ffb4b79ed00be52fc8162166a2751ea8b036f581853efe7cda744a9b7bd/ferretz-0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5520e08a80a92a7763d380a17888cf663cc3173fb604b0a44d098d6f318ff949",
"md5": "3598cbfd0002786500ea4efb47fc7718",
"sha256": "571b667a35651030927804ed4e381ded66d5f13fea9b8ae0baa91922bd871962"
},
"downloads": -1,
"filename": "ferretz-0.3.tar.gz",
"has_sig": false,
"md5_digest": "3598cbfd0002786500ea4efb47fc7718",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5484,
"upload_time": "2023-10-03T17:51:24",
"upload_time_iso_8601": "2023-10-03T17:51:24.498928Z",
"url": "https://files.pythonhosted.org/packages/55/20/e08a80a92a7763d380a17888cf663cc3173fb604b0a44d098d6f318ff949/ferretz-0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-03 17:51:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LalithShiyam",
"github_project": "ferretz",
"github_not_found": true,
"lcname": "ferretz"
}
JSON
