Publish Python library to PyPi. (#356)

Author: zongweil

python/.gitignore

@@ -1,2 +1,4 @@
 __pycache__/
 *.pyc
+openlocationcode.egg-info/*
+dist/*

python/BUILD

@@ -2,7 +2,7 @@ package(default_visibility = ["//visibility:public"])
 
 py_library(
     name = "openlocationcode",
-    srcs = ["openlocationcode.py"],
+    srcs = ["openlocationcode/openlocationcode.py"],
 )
 
 py_test(

python/README.md

@@ -3,6 +3,14 @@
 This is the Python Open Location Code library. It is tested for both python 2.7
 and python 3.6.
 
+## Installing the library
+
+The python library is available on PyPi. You can install it using pip:
+
+```
+pip install openlocationcode
+```
+
 ## Formatting
 
 Code must be formatted according to the
@@ -48,3 +56,23 @@ Run the unit tests and benchmarks locally with:
 bazel test python:openlocationcode_test
 ```
 
+
+## Releasing to PyPi
+
+We release the python library to PyPi so users can install it using pip.
+
+Pre-reqs:
+
+```
+pip install setuptools
+pip install twine
+```
+
+To release a new version to PyPi, make sure you update the version number in setup.py. Then run:
+
+```
+python setup.py sdist
+twine upload dist/*
+```
+
+Make sure any older versions are cleared out from dist before uploading. twine will prompt you for your PyPi credentials, which will need to be a collaborator on the project.

python/openlocationcode/__init__.py

@@ -0,0 +1 @@
+from openlocationcode import *

python/openlocationcode.py renamed to python/openlocationcode/openlocationcode.py

@@ -5,7 +5,7 @@
 import random
 import time
 import unittest
-import openlocationcode as olc
+from openlocationcode import openlocationcode as olc
 
 # Location of test data files.
 _TEST_DATA = 'test_data'

python/openlocationcode_test.py

@@ -0,0 +1,19 @@
+from setuptools import setup
+
+# This call to setup() does all the work
+setup(
+    name="openlocationcode",
+    version="1.0.1",
+    description="Python library for Open Location Code (Plus Codes)",
+    url="https://github.com/google/open-location-code",
+    author="Google",
+    author_email="[email protected]",
+    license="Apache 2.0",
+    classifiers=[
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3.6",
+    ],
+    packages=["openlocationcode"],
+    include_package_data=True,
+    install_requires=[],
+)