Skip to main content

Simplifies Python application rollout and publishing.

Project description

https://github.com/idlesign/makeapp

release lic 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.9.1.tar.gz (72.9 kB view details)

Uploaded Source

Built Distribution

makeapp-1.9.1-py3-none-any.whl (85.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: makeapp-1.9.1.tar.gz
  • Upload date:
  • Size: 72.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.6

File hashes

Hashes for makeapp-1.9.1.tar.gz
Algorithm Hash digest
SHA256 353151b43197f4e65edb2e297ddc69fddfabbdd02e29227a75347017c8dd6d18
MD5 6e1e1a08791c7f0f12ef65f74c809188
BLAKE2b-256 0e1ae6ef247f87b55f5c18827bda2ad21040c0e1dff8ef69c2ed185f79386e09

See more details on using hashes here.

File details

Details for the file makeapp-1.9.1-py3-none-any.whl.

File metadata

  • Download URL: makeapp-1.9.1-py3-none-any.whl
  • Upload date:
  • Size: 85.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.6

File hashes

Hashes for makeapp-1.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 43387c725a619a4bf664cece7bfb8014c32ba51838bc9ab9c579ff412aff9e83
MD5 484997cfc6be871948562bab95c1c0b5
BLAKE2b-256 b6c40086ccf6e50fa5f5209ef9373f1275e4ceceac641a2e98f2c356640da1c5

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