Merge pull request #9 from kattni/pypi

PyPi setup.

Author: brennen

.gitignore

@@ -1,7 +1,12 @@
+*.mpy
+.idea
+__pycache__
 _build
 *.pyc
-*.mpy
 .env
 build*
 bundles
-
+*.DS_Store
+.eggs
+dist
+**/*.egg-info

.travis.yml

@@ -1,32 +1,32 @@
-# This is a common .travis.yml for generating library release zip files for
-# CircuitPython library releases using circuitpython-build-tools.
-# See https://github.com/adafruit/circuitpython-build-tools for detailed setup
-# instructions.
-
 dist: trusty
 sudo: false
 language: python
 python:
-    - "3.6"
-
+- '3.6'
 cache:
-    pip: true
-
+  pip: true
 deploy:
-  provider: releases
-  api_key: $GITHUB_TOKEN
+- provider: releases
+  api_key: "$GITHUB_TOKEN"
   file_glob: true
-  file: $TRAVIS_BUILD_DIR/bundles/*
+  file: "$TRAVIS_BUILD_DIR/bundles/*"
   skip_cleanup: true
   overwrite: true
   on:
     tags: true
-
+- provider: pypi
+  user: adafruit-travis
+  on:
+    tags: true
+  password:
+    secure: apWQJCBG0Ac5t0zXV6zLmcsYiZK42Vf8gA7dgQXwYxeQp7V+Tmfn3/F5C5mH1POfY8uiHDCDnwk0vqqpmF9jNaoJ5BG4sVh2v5CifAlE+qb+jt9GsjBjq8vlhnjOKIMdw0r64qiWMrnM2zMTcmeDQlERmdb0C/5Rbq36+azPR/zUu4P8pnk/uuJelWu68SnrSeOT7GqosEN/mloyJEesu20e8taLSzYQNZ77yx+tNzPRHhxinbIx6pXp4H2jAj5euhOyRjYZb9Qm7PswyKeKcOQLM7zcPXDN4Dwo1CMITGUuITJTk8iRXW13uXQScAEdrf1PN3rWqHc+AjgiNGYFlP7+GB69xrUe5M1AQKbCiAv/cirQ5lkkdqzYGP9TVG1yGHaf5QvVI68c0NZxy2JGpeKOXAo/YwpX61KeJGfRkFwMD3uaYnRHfCWkyIhXQKwygHhGbcOAZh+xnGpA/0Z87bqkh6Wwq9+JxsO6hfkJVPUccEey/c98ilPHzXdBSdUDGdsKQWMV+HjMJx2Nes8P0ObDMdLJz15RG80YimYpphuYSRhQEx6rACgnUS426Ax8ir94hUruBHzqz3ZzJEJ4YoLdEFbIXVqB3aAY4uBykTdm4rsa1M+JcBHmT/n6Kt/HfbN37Qxg0nHMGSXTrOWAsZHU6t9Vq7Xv+wUUWYdashc=
 install:
-  - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme
-
+- pip install -r requirements.txt
+- pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme
+- pip install --force-reinstall pylint==1.9.2
 script:
-  - pylint adafruit_ds3231.py
-  - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py)
-  - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ds3231 --library_location .
-  - cd docs && sphinx-build -E -W -b html . _build/html
+- pylint adafruit_ds3231.py
+- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py)
+- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ds3231 --library_location
+  .
+- cd docs && sphinx-build -E -W -b html . _build/html && cd ..

docs/conf.py

@@ -39,7 +39,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["adafruit_bus_device", "adafruit_register"]
+# autodoc_mock_imports = ["adafruit_bus_device", "adafruit_register"]
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
 

requirements.txt

@@ -1,2 +1,2 @@
-adafruit-micropython-register
-adafruit-micropython-bus-device>=0.1.1
+adafruit-circuitpython-register
+adafruit-circuitpython-busdevice

setup.py

@@ -0,0 +1,60 @@
+"""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='adafruit-circuitpython-ds3231',
+
+    use_scm_version=True,
+    setup_requires=['setuptools_scm'],
+
+    description='CircuitPython library for DS3231 precision real-time clock.',
+    long_description=long_description,
+    long_description_content_type='text/x-rst',
+
+    # The project's main homepage.
+    url='https://github.com/adafruit/Adafruit_CircuitPython_DS3231',
+
+    # Author details
+    author='Adafruit Industries',
+    author_email='[email protected]',
+
+    install_requires=['adafruit-circuitpython-register', 'adafruit-circuitpython-busdevice'],
+
+    # Choose your license
+    license='MIT',
+
+    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: System :: Hardware',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+    ],
+
+    # What does your project relate to?
+    keywords='adafruit precision real-time real time clock breakout hardware micropython circuitpython',
+
+    # You can just specify the packages manually here if your project is
+    # simple. Or you can use find_packages().
+    py_modules=['adafruit_DS3231'],
+)