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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: puffit-1.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 f59bca54030ddbc09d5d64f01a67915abcaa8f5f2e3486364a7f504e0f4c78c0
MD5 84443fb79007f4fc8e687356bf8b1408
BLAKE2b-256 4cf70bfe41842e1f2745eaca05e21e14431351bc7d9dfaf92e596da148826206

See more details on using hashes here.

File details

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

File metadata

  • Download URL: puffit-1.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aee3c93ce95b6dcd80e9d21bd12eae37abc69b7294b89c932aee66a42f7eed26
MD5 bc14a8270d66acac2d6e6f0061009397
BLAKE2b-256 cf57c962118c307e3202bc98306b5476f782881575f9c34c490b6dd9e4969752

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