diff --git a/LICENSE b/LICENSE index ff4b65c..c48b81e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017 Marcin Sedlak +Copyright (c) 2017 Marcin Sędłak-Jakubowski Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..74d9f96 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +include LICENSE.txt +include README.rst +include requirements.txt diff --git a/README.rst b/README.rst index 2b8e687..dadcb32 100644 --- a/README.rst +++ b/README.rst @@ -10,12 +10,34 @@ What it does: 2. Maps the long-lat to a country (using `reverse geocoder `_). 3. Print out a sentence like "The ISS is currently above ". +*************** +Install and run +*************** + +To install from PyPI, run: + + ``pip install whereiss`` + +To install locally, clone or download the repo and run: + + ``pip install -r requirements.txt`` + + ``pip install -e .`` + ************ Requirements ************ -* requests -* numpy, scipy (for reverse_geocoder) * pycountry +* requests +* reverse_geocoder + +Works with Python 2.7, and >=3.5 + +************ +Contributing +************ + +Pull Requests welcome! -Works with Python 3.5 +Fork the repo, make your changes and submit a Pull Request. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6e35b34 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +pycountry +requests +reverse-geocoder diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..79bc678 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,5 @@ +[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 diff --git a/setup.py b/setup.py index 77d9507..f43716c 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,14 @@ from setuptools import setup +# 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='whereiss', @@ -7,13 +17,39 @@ description='A python tool to check where the ISS is and return the area/country below it.', + long_description=long_description, + url='https://github.com/fdmarcin/whereiss', + download_url='https://github.com/fdmarcin/whereiss/archive/0.1.tar.gz', - author='fdmarcin', + author='Marcin Sędłak-Jakubowski', author_email='fdmarcin@gmail.com', license='MIT', - install_requires=['requests', 'reverse_geocoder'] - + install_requires=['pycountry', 'requests', 'reverse_geocoder'], + + classifiers=[ + 'Development Status :: 4 - Beta', + 'Environment :: Console', + # Indicate who your project is intended for + 'Intended Audience :: End Users/Desktop', + 'Topic :: Games/Entertainment', + 'Topic :: Education', + '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.5', + 'Programming Language :: Python :: 3.6', + ], + + entry_points={ + 'console_scripts': [ + 'whereiss = whereiss:where_is_the_iss' + ] + }, ) +