= pypi =
PyPI - the Python Package Index


Minimal packaging stucture http://python-packaging.readthedocs.io/en/latest/minimal.html

{{{#!highlight sh
cd ~/vbhelloworld
python3.5 setup.py test # run tests

pip install . # install locally
pip uninstall vbhelloworld

#edit settings for pypi packages site
nano ~/.pypirc

# register user in https://testpypi.python.org
python3.5 setup.py register -r https://testpypi.python.org/pypi
# build source distribution
python3.5 setup.py sdist
# upload the source distribution to https://testpypi.python.org
python3.5 setup.py sdist upload -r https://testpypi.python.org/pypi
# uninstall local package
# install package from https://testpypi.python.org/
pip uninstall vbhelloworld
pip install -i https://testpypi.python.org/pypi vbhelloworld
}}}


{{{#!highlight sh
python3 -m pip install --user --upgrade setuptools wheel
python3 -m pip install --user --upgrade twine
rm dist/*
python3 setup.py sdist bdist_wheel
ls dist/
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
pip install -i https://testpypi.python.org/pypi vbhelloworld --user
}}}

== ~/.pypirc ==
{{{
[distutils]
index-servers=
    pypitest

[pypitest]
repository = https://testpypi.python.org/pypi
username = userx
password = passx
}}}

== Example project structure ==
=== LICENSE.txt      ===
{{{
Copyright (c) 2016 The Python Packaging Authority (PyPA)

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
}}}

=== tests/__init__.py ===
{{{#!highlight python
import unittest
from vbhelloworld import add

class SimpleTestCase(unittest.TestCase):
    def setUp(self):
        pass

    def tearDown(self):
        pass

    def testAdd(self):
        self.assertEqual(5,  add(3,2) )

if __name__ == '__main__':
    unittest.main()
}}}

=== MANIFEST.in ===
{{{
# Include the license file
include LICENSE.txt

# Include the data files
recursive-include data *
}}}

=== data/helloworld.conf ===
{{{
banner: Hello World
}}}

=== setup.cfg ===
{{{#!highlight python
[bdist_wheel]
# This flag says that the code is written to work on both Python 2 and Python
# 3. If at all possible, it is good practice to do this. If you cannot, you
# will need to generate wheels for each Python version that you support.
universal=1
}}}

=== vbhelloworld/__init__.py ===
{{{#!highlight python
import sys
import yaml

def main():
    """Entry point for the application script"""
    filex=open("/etc/helloworld.conf")
    conf= filex.read()
    filex.close()
    yamlConf = yaml.load(conf)

    if len(sys.argv) > 1:
        print("%s %s"%( yamlConf['banner'] ,  sys.argv[1]) )
    else:
        print("%s"%( yamlConf['banner'] ) )

def add(arg1,arg2):
    """ Add two values arg1 and arg2 """
    return arg1+arg2
}}}

=== README.rst ===
{{{
A hello world Python project
=======================

A hello world project.

----

This is the README file for the project.
}}}

=== setup.py ===
{{{#!highlight python
"""A setuptools based setup module.

See:
https://packaging.python.org/en/latest/distributing.html
https://github.com/pypa/sampleproject
"""

# Always prefer setuptools over distutils
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path

here = path.abspath(path.dirname(__file__))

# Get the long description from the README file
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
    long_description = f.read()

setup(
    name='vbhelloworld',

    # Versions should comply with PEP440.  For a discussion on single-sourcing
    # the version across setup.py and the project code, see
    # https://packaging.python.org/en/latest/single_source_version.html
    version='1.0.0',

    description='A hello world Python project',
    long_description=long_description,

    # The project's main homepage.
    url='https://github.com/userx/vbhelloworld',

    # Author details
    author='UserX',
    author_email='userx@gmail.com',

    # Choose your license
    license='MIT',

    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
    classifiers=[
        # How mature is this project? Common values are
        #   3 - Alpha
        #   4 - Beta
        #   5 - Production/Stable
        'Development Status :: 3 - Alpha',

        # Indicate who your project is intended for
        'Intended Audience :: Developers',
        'Topic :: Software Development :: Build Tools',

        # Pick your license as you wish (should match "license" above)
        'License :: OSI Approved :: MIT License',

        # Specify the Python versions you support here. In particular, ensure
        # that you indicate whether you support Python 2, Python 3 or both.
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.6',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.3',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
    ],

    # What does your project relate to?
    keywords='vbhelloworld setuptools development',

    # You can just specify the packages manually here if your project is
    # simple. Or you can use find_packages().
    packages=find_packages(exclude=['contrib', 'docs', 'tests']),

    # Alternatively, if you want to distribute just a my_module.py, uncomment
    # this:
    #   py_modules=["my_module"],

    # List run-time dependencies here.  These will be installed by pip when
    # your project is installed. For an analysis of "install_requires" vs pip's
    # requirements files see:
    # https://packaging.python.org/en/latest/requirements.html
    install_requires=['pyyaml'],

    # List additional groups of dependencies here (e.g. development
    # dependencies). You can install these using the following syntax,
    # for example:
    # $ pip install -e .[dev,test]
    extras_require={
        'dev': ['check-manifest'],
        'test': ['coverage'],
    },

    # If there are data files included in your packages that need to be
    # installed, specify them here.  If using Python 2.6 or less, then these
    # have to be included in MANIFEST.in as well.
    #package_data={
    #    'sample': ['package_data.dat'],
    #},

    # Although 'package_data' is the preferred approach, in some case you may
    # need to place data files outside of your packages. See:
    # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa
    # In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
    data_files=[('/etc', ['data/helloworld.conf'])],

    # To provide executable scripts, use entry points in preference to the
    # "scripts" keyword. Entry points provide cross-platform support and allow
    # pip to create the appropriate form of executable for the target platform.
    entry_points={
        'console_scripts': [
            'helloworld=vbhelloworld:main',
        ],
    },
)
}}}


== sdist tar.gz content ==
 * cd dist
 * tar tvzf vbhelloworld-1.0.0.tar.gz
{{{
data/
data/helloworld.conf
vbhelloworld/
vbhelloworld/__init__.py
vbhelloworld.egg-info/
vbhelloworld.egg-info/PKG-INFO
vbhelloworld.egg-info/SOURCES.txt
vbhelloworld.egg-info/dependency_links.txt
vbhelloworld.egg-info/entry_points.txt
vbhelloworld.egg-info/requires.txt
vbhelloworld.egg-info/top_level.txt
LICENSE.txt
MANIFEST.in
README.rst
setup.cfg
setup.py
PKG-INFO
}}}

= Submit to prod repository and install =
 * python3.4 setup.py register -r  https://pypi.python.org/pypi
 * python3.4 setup.py sdist
 * python3.4 setup.py sdist upload -r  https://pypi.python.org/pypi
 * pip uninstall vbhelloworld
 * pip install --user vbhelloworld

{{{#!highlight bash
$ find . -name "hello*"
~/.local/lib64/python2.7/site-packages/home/vborrego/helloworld.conf
~/.local/bin/helloworld
cp ~/.local/lib64/python2.7/site-packages/home/vborrego/helloworld.conf ~/

PATH=$PATH:~/.local/bin
}}}