Name | puffit JSON |
Version |
1.0.5
JSON |
| download |
home_page | None |
Summary | puffit generates directory structure from text templates |
upload_time | 2024-09-12 16:26:20 |
maintainer | None |
docs_url | None |
author | Bryce Jenkins |
requires_python | <=3.12,>=3.9 |
license | None |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# PuffIt
I've always wanted to take an example directory structure for a project structure and pipe that into an application to make it happen. So that's what this is for.
For example I would like to take this:
```
root/
├── tasks/
│ ├── __init__.py
│ ├── task_a.py
│ └── task_b.py
├── core/
│ ├── app.py
│ ├── celery_worker.py
│ └── config.py
├── Dockerfile
├── docker-compose.yml
├── requirements.txt
└── README.md
```
And have it turn into this:
![alt text](/docs/imgs/image.png)
### GitHub Actions Status
![Coverage](https://github.com/thechainercygnus/puffit/actions/workflows/coverage.yml/badge.svg) ![Format](https://github.com/thechainercygnus/puffit/actions/workflows/lint_and_format.yml/badge.svg) ![Publish](https://github.com/thechainercygnus/puffit/actions/workflows/publish.yml/badge.svg) ![Security](https://github.com/thechainercygnus/puffit/actions/workflows/security.yml/badge.svg) ![Version](https://github.com/thechainercygnus/puffit/actions/workflows/version.yml/badge.svg)
### Test Status
![Tests](https://github.com/thechainercygnus/puffit/actions/workflows/tests.yml/badge.svg) ![coverage](./docs/badges/coverage.svg)
## Features
Supports a variety of layout syntaxes.
## Installation
pipx install puffit
## Usage
Create your `template.pft` file containing the textual layout for the project. Then just run `puffit template.pft` where you'd like to create your new project directory. Check out `templates/` for example `.pft` files.
## Contributing
Coming Soon
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Roadmap
* Integreate CI/CD release automation
* Improve error handling
* Improve documentation
* Implement logging
Raw data
{
"_id": null,
"home_page": null,
"name": "puffit",
"maintainer": null,
"docs_url": null,
"requires_python": "<=3.12,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Bryce Jenkins",
"author_email": "bryce@durish.xyz",
"download_url": "https://files.pythonhosted.org/packages/8f/8e/bdfb9b860f1ab88f0e1b1116e0e745b5e3cf3f1edd3df25e7e54d36cf909/puffit-1.0.5.tar.gz",
"platform": null,
"description": "# PuffIt\n\nI've always wanted to take an example directory structure for a project structure and pipe that into an application to make it happen. So that's what this is for.\n\nFor example I would like to take this:\n\n```\nroot/\n\u251c\u2500\u2500 tasks/\n\u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u251c\u2500\u2500 task_a.py\n\u2502 \u2514\u2500\u2500 task_b.py\n\u251c\u2500\u2500 core/\n\u2502 \u251c\u2500\u2500 app.py\n\u2502 \u251c\u2500\u2500 celery_worker.py\n\u2502 \u2514\u2500\u2500 config.py\n\u251c\u2500\u2500 Dockerfile\n\u251c\u2500\u2500 docker-compose.yml\n\u251c\u2500\u2500 requirements.txt\n\u2514\u2500\u2500 README.md\n```\n\nAnd have it turn into this:\n\n![alt text](/docs/imgs/image.png)\n\n\n### GitHub Actions Status\n![Coverage](https://github.com/thechainercygnus/puffit/actions/workflows/coverage.yml/badge.svg) ![Format](https://github.com/thechainercygnus/puffit/actions/workflows/lint_and_format.yml/badge.svg) ![Publish](https://github.com/thechainercygnus/puffit/actions/workflows/publish.yml/badge.svg) ![Security](https://github.com/thechainercygnus/puffit/actions/workflows/security.yml/badge.svg) ![Version](https://github.com/thechainercygnus/puffit/actions/workflows/version.yml/badge.svg)\n\n### Test Status\n![Tests](https://github.com/thechainercygnus/puffit/actions/workflows/tests.yml/badge.svg) ![coverage](./docs/badges/coverage.svg)\n\n## Features\n\nSupports a variety of layout syntaxes.\n\n## Installation\n\npipx install puffit\n\n## Usage\n\nCreate your `template.pft` file containing the textual layout for the project. Then just run `puffit template.pft` where you'd like to create your new project directory. Check out `templates/` for example `.pft` files.\n\n## Contributing\n\nComing Soon\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Roadmap\n\n* Integreate CI/CD release automation\n* Improve error handling\n* Improve documentation\n* Implement logging\n\n",
"bugtrack_url": null,
"license": null,
"summary": "puffit generates directory structure from text templates",
"version": "1.0.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "455a014a4e515a56108dc9abad2a4dfccd5375d711669d095002ae6799157e0e",
"md5": "5d9b4cc06651deb5346e0258802cc0d8",
"sha256": "9435b821c538bd66d44ba2b1db10ebc8fd65d5a12aa2f92983f2334f686a6306"
},
"downloads": -1,
"filename": "puffit-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d9b4cc06651deb5346e0258802cc0d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<=3.12,>=3.9",
"size": 5936,
"upload_time": "2024-09-12T16:26:19",
"upload_time_iso_8601": "2024-09-12T16:26:19.432962Z",
"url": "https://files.pythonhosted.org/packages/45/5a/014a4e515a56108dc9abad2a4dfccd5375d711669d095002ae6799157e0e/puffit-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f8ebdfb9b860f1ab88f0e1b1116e0e745b5e3cf3f1edd3df25e7e54d36cf909",
"md5": "cbb8f10f194fbe6c7c33608e7dbf8b9a",
"sha256": "05928ee2d9cbf1972e330630ccc1b8a5bcf4350acc7879d7aaaed45ffac1477d"
},
"downloads": -1,
"filename": "puffit-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "cbb8f10f194fbe6c7c33608e7dbf8b9a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<=3.12,>=3.9",
"size": 4741,
"upload_time": "2024-09-12T16:26:20",
"upload_time_iso_8601": "2024-09-12T16:26:20.710885Z",
"url": "https://files.pythonhosted.org/packages/8f/8e/bdfb9b860f1ab88f0e1b1116e0e745b5e3cf3f1edd3df25e7e54d36cf909/puffit-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 16:26:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "puffit"
}