Skip to main content

Simplifies Python application rollout and publishing.

Project description

https://github.com/idlesign/makeapp

LBC Python 2

release lic ci coverage

Description

Simplifies Python application rollout and publishing.

  • Make a skeleton for your new application with one console command.

  • Automatically create a VCS repository for your application.

  • Automatically check whether the chosen application name is not already in use.

  • Customize new application layouts with skeleton templates.

  • Put some skeleton default settings into a configuration file not to mess with command line switches anymore.

  • Easily add entries to your changelog.

  • Publish your application to remotes (VCS, PyPI) with single command.

Application scaffolding

Scaffold a new application:

$ makeapp new my_new_app /home/librarian/mynewapp/ -d "My application." --author "The Librarian"

This will create a decent application skeleton using the default skeleton template (setup.py, docs, tests, etc.) and initialize Git repository.

makeapp bundles some commonly used templates for:

  • click powered app

  • pytest powered app

  • pytest plugin

  • Django app

  • webscaff project

  • etc.

Multiple templates can be used together. Complete list of featured templates can be found in the documentation. User-made templates are also supported.

Application publishing

When you’re ready to publish issue the following command while in project directory (containing setup.py):

$ makeapp release
; Bump version number part manually: major, minor, patch
$ makeapp release --increment major

This will automatically:

  • bump up application version number

  • tag version in VCS

  • push sources to remote repository

  • upload application package to PyPI

Adding changes

When you’re ready to add another entry to your changelog use change command:

$ makeapp change "+ New 'change' command implemented"

This will also stage and commit all changed files.

Supported message prefixes:

  • + - New feature / addition.

    Increments minor part of version number on release command.

  • ! - Important change/improvement/fix.

    Increment: patch part.

  • - - Feature deprecation / removal

    Increment: patch.

  • * - Minor change/improvement/fix. * prefix is added by default in none of the above mentioned prefixes found.

    Increment: patch.

Bash completion

To enable bash completion for makeapp command append the following line into your .bashrc:

eval "$(_MAKEAPP_COMPLETE=source makeapp)"

Documentation

https://makeapp.readthedocs.org/

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

makeapp-1.6.1.tar.gz (66.6 kB view details)

Uploaded Source

Built Distribution

makeapp-1.6.1-py2.py3-none-any.whl (83.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file makeapp-1.6.1.tar.gz.

File metadata

  • Download URL: makeapp-1.6.1.tar.gz
  • Upload date:
  • Size: 66.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for makeapp-1.6.1.tar.gz
Algorithm Hash digest
SHA256 890f5f793774232a8c0b8784177cca0870c4b2a3bb5a12a4ff952c2aa20cf432
MD5 2d2b4a24e361f73fa93e35c2db60e84c
BLAKE2b-256 f1c37991b179edb8fce5d617004b42b4089a038ae5ec82828b55cb26cca37eaf

See more details on using hashes here.

File details

Details for the file makeapp-1.6.1-py2.py3-none-any.whl.

File metadata

  • Download URL: makeapp-1.6.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 83.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for makeapp-1.6.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 13465ef6fb4f9015bbb90e6a575b52d4232829e4305a785c0694cd689cd12029
MD5 70188690a0d3bc669657daac3456fa8f
BLAKE2b-256 14c95fa1b66affae4c25df0fec8a0a28f9e7003da9949c6d6c630291d34d9359

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