ptool 0.5

Skeleton project generator for various programming languages

Skeleton project generator for various programming languages

Templates are available here

Install prerequisites

Linux (Ubuntu)

sudo apt-get install python-minimal python-pip
pip install --upgrade pip
sudo pip install virtualenv

Installation

Until I can be motivated to write a proper installer…

Linux and macOS

git clone [e-mail]:rcook/ptool.git
cp ptool/ptool-sample /path/to/ptool

The location /path/to/ptool should be somewhere on the system search path. Edit the contents of the result file to point to the “real” ptool in the script subdirectory of the Git repo.

Set up Python virtual environment

script/virtualenv

Dev-install main script into virtual environment

script\env pip install -e .

This will allow edits to the scripts to be picked up automatically

Run main script in virtual environment

script/env ptool --version

Build package

script/env python setup.py build

Test package

script/env python setup.py test

Upload package

script/env python setup.py sdist upload

Install package into global site packages

python setup.py install --record files.txt

Note that this calls the python global Python instead of the Python in the project’s virtual environment.

Notes

Various package properties are defined in ptool/__init__py:

• __project_name__

• __version__

• __description__

When publishing a new build of the package, ensure that __version__ is incremented as appropriate.

User-level installation

pip install --user ptool

This will perform a user-level installation of the package. The scripts will be placed at:

• Windows: %APPDATA%\Python\Scripts

• Linux/macOS: $HOME/.local/bin

Global installation

pip install ptool

This will perform a global installation of the package and should add the script to PATH.

Usage

usage: ptool [-h] [--version] {new,templates,values,update} ...

Skeleton project generator for various programming languages

positional arguments:
  {new,templates,values,update}
                        subcommand help
    new                 Create new project from template
    templates           List available templates
    values              List all values available to templates
    update              Update local template repository

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

Licence

Released under MIT License