Skip to main content

Simplifies Python application rollout and publishing.

Project description

https://github.com/idlesign/makeapp

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 also bundles templates for commonly used application types:

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 if 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.8.4.tar.gz (67.6 kB view details)

Uploaded Source

Built Distribution

makeapp-1.8.4-py2-none-any.whl (84.4 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for makeapp-1.8.4.tar.gz
Algorithm Hash digest
SHA256 b50af9edb3bf80dd0cf5159d2eaee8aa3898d4b0292812ce402007cb2d5d7506
MD5 a717682de630b7e7552825339a2b3508
BLAKE2b-256 cbcba6e2105ded5c5fd9090dc131beb8451e3a365485fdbf1e682673a7b6b305

See more details on using hashes here.

File details

Details for the file makeapp-1.8.4-py2-none-any.whl.

File metadata

  • Download URL: makeapp-1.8.4-py2-none-any.whl
  • Upload date:
  • Size: 84.4 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for makeapp-1.8.4-py2-none-any.whl
Algorithm Hash digest
SHA256 6c55b50f5fb355ca1be57a2fd00ab2ffd6388e61f734330f5cd4d081fc914511
MD5 46d2804815de09380dc2bb9026419c44
BLAKE2b-256 53fda909df06e85d7da3cbc2dc5df6f59401d0c2f3904fcdd773336c04134e81

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