Skip to main content

No project description provided

Project description

skel

A quick skeleton generator for projects.

Fun fact: this project was generated using skel's python-cli template.

Installation

From Pip

Run pip3 install skelgen.

From Source

Clone this repo.

Run python3 setup.py install to install globally. Run python3 setup.py install --user to install for one user.

Usage

Run skel --help for help.

Example usage: Run skel python-cli --path test to generate a Python CLI application in the test directory.

Features

Available templates:

  • python, a basic Python package structure
  • python-cli, like python, but includes logic for installing as a command line application
  • cmake, a basic C++ CMake project structure
  • zephyr, a basic Zephyr RTOS C application template
  • flask-api, a Flask CRUD API template with authentication based on SQLAlchemy

Available "shortcut" templates (which just call a separate scaffolder):

  • react
  • preact
  • vue
  • nuxt

Planned templates:

  • flask, a basic Flask template with GUI
  • pyside-gui, a deployable PySide6 application with PyInstaller
  • pyuavcan, a basic PyUAVCAN based application
  • caspar-graphics, a basic CasparCG HTML templates project

Contributing

Got an idea for a template? Put in a merge request! It's very easy to create a custom project template. All file/folder names and contents are templated using the Jinja2 template engine. All you need to do is write the templates, add a ___template.py for configuration (see the Python template for examples), and rebuild!

We also appreciate feature requests and bug reports.

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

skelgen-1.2.0.tar.gz (19.3 kB view details)

Uploaded Source

File details

Details for the file skelgen-1.2.0.tar.gz.

File metadata

  • Download URL: skelgen-1.2.0.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5

File hashes

Hashes for skelgen-1.2.0.tar.gz
Algorithm Hash digest
SHA256 c8f30a10d38771d9a1b4c41a20de5077a73e870854feefafecbe08756958b9bb
MD5 2b64e8ab7d297001ad9c47ff3e3be2fa
BLAKE2b-256 50d981d2762ae379247ea8608984ebfc704ba7cc6185abb72e0e43e0728326ec

See more details on using hashes here.

Supported by

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