PyPI setup.
This commit is contained in:
parent
f3adc13ef1
commit
51554c63dc
4 changed files with 117 additions and 21 deletions
6
.gitignore
vendored
6
.gitignore
vendored
|
|
@ -1,6 +1,12 @@
|
|||
*.mpy
|
||||
.idea
|
||||
__pycache__
|
||||
_build
|
||||
*.pyc
|
||||
.env
|
||||
build*
|
||||
bundles
|
||||
*.DS_Store
|
||||
.eggs
|
||||
dist
|
||||
**/*.egg-info
|
||||
41
.travis.yml
41
.travis.yml
|
|
@ -1,33 +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: xenial
|
||||
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: SmBi9h4UAQXlYVfOJ7+o+SmOjczVNIQ5mhzB/tYxrsxdJnZygcYAQ1firFvtrzPDURlUThp84ZUGOS0GnvZH2RCXUL5y+28U64FboRQFCqj/6JeHvy0IPCizzA1J/7vKBF49ReTOmFGcgGjJAGLKLGXaSkriWAWbKZ861eu21Ctd7/jRazVdVviJj/X4FGiAXOOaVImxBJSWm/mxQnCZvoQBdySG15J2aBbCRPhqTUQvOPEdFIVf93/hXXcV5ccNOuuJwTvrP3itM6eJ7neX5aNP9Lz/YF0AosQRdJT1MYiy0/WMh3IvgKuICH5ShDg5IphnICqKnOCHf2xLYDJzchr7k3xWfXEvoWz+ZkTGTlUx52Qj7jisC8cl00izuEf3s9wPWk4hOp5N+JoeSyTp43Ap98pTgwAT5dIHu1IzzTtGgf5UMFlfhVbfCS8GiuGdnywbgTI/L5bqMdueW45VGB2ttxDqVFkRr40OBwnJlunOkGuJesmLn0IDBxjWLNez96gfEagQaewzFFun/JJGIojOv81SrFECz7GrNl3SZtFQaSdHwHc3BuJ/gYkBEOF5KF9QOAjTgsq2lsWZxbkREEBq4wG2npSLlHO1BvH+6p0JAy6gMtENprHFeYR9Bl2r+5KaQzoa6GAswmESGB+mzoxVJHzQpW86Pi8yIfnxJSg=
|
||||
install:
|
||||
- pip install -r requirements.txt
|
||||
- pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
|
||||
- pip install --force-reinstall pylint==1.9.2
|
||||
|
||||
- pip install -r requirements.txt
|
||||
- pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
|
||||
- pip install --force-reinstall pylint==1.9.2
|
||||
script:
|
||||
- pylint adafruit_adt7410.py
|
||||
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
|
||||
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-adt7410 --library_location .
|
||||
- cd docs && sphinx-build -E -W -b html . _build/html && cd ..
|
||||
- pylint adafruit_adt7410.py
|
||||
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace
|
||||
examples/*.py)
|
||||
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-adt7410 --library_location
|
||||
.
|
||||
- cd docs && sphinx-build -E -W -b html . _build/html && cd ..
|
||||
|
|
|
|||
25
README.rst
25
README.rst
|
|
@ -27,6 +27,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
|
|||
This is easily achieved by downloading
|
||||
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
|
||||
|
||||
Installing from PyPI
|
||||
--------------------
|
||||
|
||||
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
|
||||
PyPI <https://pypi.org/project/adafruit-circuitpython-adt7410/>`_. To install for current user:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
pip3 install adafruit-circuitpython-adt7410
|
||||
|
||||
To install system-wide (this may be required in some cases):
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
sudo pip3 install adafruit-circuitpython-adt7410
|
||||
|
||||
To install in a virtual environment in your current project:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
mkdir project-name && cd project-name
|
||||
python3 -m venv .env
|
||||
source .env/bin/activate
|
||||
pip3 install adafruit-circuitpython-adt7410
|
||||
|
||||
Usage Example
|
||||
=============
|
||||
|
||||
|
|
|
|||
66
setup.py
Normal file
66
setup.py
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
"""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-adt7410',
|
||||
|
||||
use_scm_version=True,
|
||||
setup_requires=['setuptools_scm'],
|
||||
|
||||
description='CircuitPython driver for reading temperature from the Analog Devices ADT7410 '
|
||||
'precision temperature sensor.',
|
||||
long_description=long_description,
|
||||
long_description_content_type='text/x-rst',
|
||||
|
||||
# The project's main homepage.
|
||||
url='https://github.com/adafruit/Adafruit_CircuitPython_ADT7410',
|
||||
|
||||
# Author details
|
||||
author='Adafruit Industries',
|
||||
author_email='circuitpython@adafruit.com',
|
||||
|
||||
# TODO: List all packages required for this library, likely found in requirements.txt
|
||||
install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice',
|
||||
'adafruit-circuitpython-register'],
|
||||
|
||||
# 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?
|
||||
# TODO: Add search keywords here, separated by a space
|
||||
keywords='adafruit analog precision temperature sensor hardware adt7410 '
|
||||
'micropython circuitpython',
|
||||
|
||||
# You can just specify the packages manually here if your project is
|
||||
# simple. Or you can use find_packages().
|
||||
# TODO: CHANGE py_modules= TO packages= IF LIBRARY FILES ARE A PACKAGE FOLDER
|
||||
py_modules=['adafruit_adt7410'],
|
||||
)
|
||||
Loading…
Reference in a new issue