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.1.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: puffit-1.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 906cd7eb41148960371c40a04c0be5cec71060e8a46995f5e279e188846cfb02
MD5 46c2dfd31334947f965c42bb1ab1dfde
BLAKE2b-256 56fe6d94aeb16b929e669ca8ee5b46a0dc85fabe034a4102a3a839dff908c632

See more details on using hashes here.

File details

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

File metadata

  • Download URL: puffit-1.0.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d3a2d5c90631af58a0ee09815f1486d14e31b5fe643506bfef9363e635382383
MD5 e0ccd4086f41fd1d2822c9ab1e0a752c
BLAKE2b-256 b62521b9aefcfcf1375e172aabe5835ca5946c7393a42c2fdb8dedf6135add3f

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