Skip to main content

puffit generates directory structure from text templates

Project description

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

GitHub Actions Status

Coverage Format Publish Security Version

Test Status

Tests coverage

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 file for details.

Roadmap

  • Integreate CI/CD release automation
  • Improve error handling
  • Improve documentation
  • Implement logging

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

puffit-1.0.4.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

puffit-1.0.4-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file puffit-1.0.4.tar.gz.

File metadata

  • Download URL: puffit-1.0.4.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for puffit-1.0.4.tar.gz
Algorithm Hash digest
SHA256 653579883db34f7f392ebac8f525ed913533368cac909d7c93f97edceb81924a
MD5 890ef5eb2fba4e9a4199f78fc2f4a913
BLAKE2b-256 075ed3a7f7f9d9072cee14ee0c9122bf4defe2c4119e523de8387f9a44150816

See more details on using hashes here.

File details

Details for the file puffit-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: puffit-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for puffit-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6077ecf970c7f5d7aec0798e774866397bd318ed164a9d83e98477a069725d2a
MD5 7e39d353254820461bf5d87f0cebadcb
BLAKE2b-256 08355db2cc82e9132b3f5ef654e8b0e7ce5bf4515a4ab73649bddef102ea25c0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page