Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Prepare for PyPI upload. #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
include LICENSE.txt
include README.rst
include requirements.txt
28 changes: 25 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,34 @@ What it does:
2. Maps the long-lat to a country (using `reverse geocoder <https://github.com/thampiman/reverse-geocoder>`_).
3. Print out a sentence like "The ISS is currently above <place>".

***************
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.
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pycountry
requests
reverse-geocoder
5 changes: 5 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -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
42 changes: 39 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
@@ -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',
Expand All @@ -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='[email protected]',

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'
]
},
)