diff --git a/poc_scraper/setup.py b/poc_scraper/setup.py index 0412d31..74f81b0 100644 --- a/poc_scraper/setup.py +++ b/poc_scraper/setup.py @@ -1,46 +1,116 @@ -import os +"""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 = os.path.abspath(os.path.dirname(__file__)) -with open(os.path.join(here, 'README.md')) as f: - README = f.read() -with open(os.path.join(here, 'CHANGES.md')) as f: - CHANGES = f.read() +here = path.abspath(path.dirname(__file__)) -requires = [ - 'pymongo', - 'pycomm', - 'pycomm_helper', -] - -tests_require = [ - 'pytest', -] +# Get the long description from the README file +with open(path.join(here, 'README.md'), encoding='utf-8') as f: + long_description = f.read() setup( name='poc_scraper', - version='0.0', - description='Modbus TCP Server for Henry POC', - long_description=README + '\n\n' + CHANGES, + + # 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='0.0.1', + + description='MongoDB Scraper for Henry POC', + long_description=long_description, + + # The project's main homepage. + url='https://github.com/Henry-Pump/POC-to-ModbusTCP/tree/master/poc_scraper', + + # Author details + author='Patrick McDonagh', + author_email='patrickjmcd@gmail.com', + + # Choose your license + license='HenryPump', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers classifiers=[ - 'Programming Language :: Python', - 'Framework :: Pyramid', - 'Topic :: Internet :: WWW/HTTP', - 'Topic :: Internet :: WWW/HTTP :: WSGI :: Application', + # 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.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', ], - dependency_links=['https://github.com/Henry-Pump/Pycomm-Helper/tarball/master#egg=pycomm_helper-0.1'], - author='', - author_email='', - url='', - keywords='web', - packages=find_packages(), - include_package_data=True, - zip_safe=False, + + # What does your project relate to? + keywords='plc henrypump modbustcp', + + # 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=[ + 'pymongo', + 'pycomm', + 'pycomm_helper', + ], + dependency_links=[ + 'https://github.com/Henry-Pump/Pycomm-Helper/tarball/master#egg=pycomm_helper-0.1', + ], + # 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={ - 'testing': tests_require, + 'dev': ['check-manifest'], + 'test': ['coverage', 'pytest'], }, - install_requires=requires, + + # 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 '/my_data' + # data_files=[('my_data', ['data/data_file'])], + + # 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': [ 'poc_scraper = poc_scraper:main',