Metadata-Version: 1.1
Name: ptool
Version: 0.5
Summary: Skeleton project generator for various programming languages
Home-page: https://github.com/rcook/ptool
Author: Richard Cook
Author-email: rcook@rcook.org
License: MIT
Description-Content-Type: UNKNOWN
Description: ptool

        =====

        

        |View on PyPI| |Licence|

        

        Skeleton project generator for various programming languages

        

        Templates are available

        `here <https://github.com/rcook/ptool-templates>`__

        

        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 git@github.com: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 <LICENSE>`__

        

        .. |View on PyPI| image:: https://img.shields.io/pypi/v/ptool.svg

           :target: https://pypi.python.org/pypi/ptool

        .. |Licence| image:: https://img.shields.io/badge/license-MIT-blue.svg

           :target: https://raw.githubusercontent.com/rcook/ptool/master/LICENSE

        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
