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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: puffit-1.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 22ff212d037a0d6d375ff265c2a62d63dc4413d9c28a9e3a9113d8f7581f3d3e
MD5 3d2f6fec596f26f890c2fd874d5f845b
BLAKE2b-256 28bd2561c92a6fd92eaf3aa0c509a1f9e436654c27c6c7e7eb06558a8509738c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: puffit-1.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e1086689d06e5200e096077842d99035479601c25b96861af1a93066157681fd
MD5 46944820a03ba1f44da70900349e12d3
BLAKE2b-256 a1a9a373493091a369296804a33f05e27ed60c909cd115cb2e39699a6ad167b8

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