Skip to main content

Radically simple app initialization

Project description

https://img.shields.io/travis/bzurkowski/boil.svg https://api.codeclimate.com/v1/badges/b56e0c5a0856da0c35ba/maintainability https://img.shields.io/pypi/v/boil.svg https://img.shields.io/pypi/l/boil.svg https://img.shields.io/pypi/pyversions/boil.svg https://img.shields.io/codecov/c/github/bzurkowski/boil.svg

Initialization of new software projects should be quick and easy. Period.

Boil’s mission is to build a centralized, pluggable and community-driven repository of project templates for various technologies, managed via single API.

These are the problems that it aims to solve:

  • Wasting time on initializing new software projects from scratch

    In particular: creating a file structure, checking naming conventions, determining dependencies and completing basic metadata. No matter how many times we would initialize the project, it almost always requires documentation lookup. This time can be usefully spent on something else.

  • Poor quality and lack of consistency between projects

    Most developers initiate projects in their own way without complying with generally accepted standards. Often due to lack of time, projects are initialized neglectfully, have no maintenance-friendly structure and are poorly documented.

  • Burden of bootstrapping tools

    Separate app generator for Ansible, Django, Rails, etc.. Their advantage is greater flexibility and extended functionality, but it is not always what you need. Switching between one and the other may be troublesome considering the variety of APIs and different configuration options for each tool.

Installation

Use pip or easy_install:

$ pip install boil

Usage

$ boil
Usage:
    boil list
    boil search <phrase>
    boil new <plate_name> [--target-dir=<dir>]
    boil -h | --help

Options:
    --target-dir=<dir>  Target directory where project files should be
                        populated.

List all available plates:

$ boil list

Search for plates:

$ boil search <phrase>

Initialize new project from selected plate:

$ boil new <plate_name>

Examples

List all available plates:

$ boil list

Search for Python-related plates:

$ boil search python

Initialize new Python package:

$ boil new python_package

Initialize new Django app:

$ boil new django_app

Initialize new Rails app:

$ boil new rails_app

Initialize new Ruby gem:

$ boil new gem

Initialize new Bash command-line tool:

$ boil new bash_cli

Initialize new Ansible role:

$ boil new ansible_role

Initialize new plate:

$ boil new plate

Changelog

All notable changes to this project are documented in the CHANGELOG.

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

boil-0.2.0.tar.gz (34.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

boil-0.2.0-py2-none-any.whl (52.4 kB view details)

Uploaded Python 2

File details

Details for the file boil-0.2.0.tar.gz.

File metadata

  • Download URL: boil-0.2.0.tar.gz
  • Upload date:
  • Size: 34.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for boil-0.2.0.tar.gz
Algorithm Hash digest
SHA256 82312131bcf83a643d324d63ac8bb3f68acf11dade743366c706a243246be1d9
MD5 991edd317fa9dada48d07e4baa14bb36
BLAKE2b-256 f8514cd1aa04e69369939b6e0debb2ff36cf520b41b5ad153e773cb52c6fac41

See more details on using hashes here.

File details

Details for the file boil-0.2.0-py2-none-any.whl.

File metadata

  • Download URL: boil-0.2.0-py2-none-any.whl
  • Upload date:
  • Size: 52.4 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for boil-0.2.0-py2-none-any.whl
Algorithm Hash digest
SHA256 43dd4d22ac9987dee701986a9b144e9cb0bbcc69cd8680ae01d0721f334710f1
MD5 ea0a8b270e835b83f4a641e1c8bb476d
BLAKE2b-256 2fadcc47dd90527a06ad4b3f9cedc2e75227cc3ebebf6fd5ab99c651186bef7b

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