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

Uploaded Source

Built Distribution

makeapp-1.8.1-py2-none-any.whl (84.1 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for makeapp-1.8.1.tar.gz
Algorithm Hash digest
SHA256 fe7aa101ae8cb4623510ad312e9902caf1f1141477935a8293c595d917e34dc5
MD5 15b3d514edf39cede173b3fe718707a4
BLAKE2b-256 2e549b09e59ace44eaf43431f69272524b8b70d5a535e5390172fc9182a4ff24

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for makeapp-1.8.1-py2-none-any.whl
Algorithm Hash digest
SHA256 f8d64452d6f805c3732f4c4c46e99c9ea6f843b5022755f8b6cd37c2490a809c
MD5 89caf31a97334b8d81764dde752ae192
BLAKE2b-256 3bbee500a7198037c61b55b96808e4bf92f99c50b68a7e457738d57226330bac

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