Metadata-Version: 1.1
Name: sniptool
Version: 0.4
Summary: Code snippet management tool
Home-page: https://github.com/rcook/sniptool
Author: Richard Cook
Author-email: rcook@rcook.org
License: MIT
Description-Content-Type: UNKNOWN
Description: sniptool by Richard Cook

        ========================

        

        Code snippet management tool

        

        Clone repository

        ----------------

        

        ::

        

            git clone https://github.com/rcook/sniptool.git

        

        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 sniptool --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 ``sniptool/__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 sniptool

        

        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 sniptool

        

        This will perform a global installation of the package and should add

        the script to ``PATH``.

        

        Licence

        -------

        

        Released under `MIT License <LICENSE>`__

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