Skip to content

Commit 1e4f574

Browse files
brennenbrennen
authored
Merge pull request #2 from kattni/pypi-setup
PyPI setup.
2 parents d7c901f + 8584d48 commit 1e4f574

File tree

4 files changed

+115
-23
lines changed

4 files changed

+115
-23
lines changed

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1+
*.mpy
2+
.idea
13
__pycache__
24
_build
35
*.pyc
46
.env
57
build*
68
bundles
9+
*.DS_Store
10+
.eggs
11+
dist
12+
**/*.egg-info

‎.travis.yml‎

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,30 @@
1-
# This is a common .travis.yml for generating library release zip files for
2-
# CircuitPython library releases using circuitpython-build-tools.
3-
# See https://github.com/adafruit/circuitpython-build-tools for detailed setup
4-
# instructions.
5-
61
dist: xenial
72
language: python
83
python:
9-
- "3.6"
10-
4+
- '3.6'
115
cache:
12-
pip: true
13-
6+
pip: true
147
deploy:
15-
provider: releases
16-
api_key: $GITHUB_TOKEN
8+
- provider: releases
9+
api_key: "$GITHUB_TOKEN"
1710
file_glob: true
18-
file: $TRAVIS_BUILD_DIR/bundles/*
11+
file: "$TRAVIS_BUILD_DIR/bundles/*"
1912
skip_cleanup: true
2013
overwrite: true
2114
on:
2215
tags: true
23-
16+
- provider: pypi
17+
user: adafruit-travis
18+
on:
19+
tags: true
20+
password:
21+
secure: jD9bwsgkNOC+dTxiR0icmVXyW8f3AxMAUIuRBdBDliLxaz0MGM9/apNA+Kmi38Y2caaf9IO+VIiTLUeY6Yf3D8DdISyH8qRK9x/LnGVzhLpSOmQk0e+LQdDkjgosLiNOFHrE2TiDI8RE/XOaMXFjlhL2gGjDnTLevBuJOuiXiOFSuVGNkG88AperrGcNRNAsc1M5RzvhB+yLsuVquS2/UbE/9xK1UyAGu8/49MdnjCK6hiqZKWz8AnFhqrxbKaljLaonC2vXScKqEa+V4kC1acPoEDVGUMTtkQOK3uLGOuKgEwH6avWWF8pMVBBQAXjuNMl7YIIs83T8zPptTVO1mKe9wbIEwYB072WLgq9uNdiyYXTUieUKphPSaN75sOD5Tk5XCiCRYMxb7+bfSA136V3Gt7pT/MCO1yDSaZBwNKi3cZgpS3a7Kp0m5C8sjz3+STFtL49XaDfiUioALyd4IZLj6H9fEoeJzIXQp4uX1nWFDxu1NphdfuQBdB/8M0Pss9dZYbMzFN3Ms2XDPcbZ1inbtnxmcMvscx9OrtmZJ33bDj3cC5q1hA5jekqCoJlkuULAu/8EEtUADHOFw11LH53encVsSMMcDECUTNGU5JbRbhEW2d1pF7khrjvHSu7CsjyGm0i1VusyqA23RgXOUQtzcG2L9wrcgn+PxQOSd2c=
2422
install:
25-
- pip install -r requirements.txt
26-
- pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
27-
- pip install --force-reinstall pylint==1.9.2
28-
23+
- pip install -r requirements.txt
24+
- pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
25+
- pip install --force-reinstall pylint==1.9.2
2926
script:
30-
- pylint adafruit_servokit.py
31-
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
32-
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-servokit --library_location .
33-
- cd docs && sphinx-build -E -W -b html . _build/html && cd ..
27+
- pylint adafruit_servokit.py
28+
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
29+
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-servokit --library_location .
30+
- cd docs && sphinx-build -E -W -b html . _build/html && cd ..

‎README.rst‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Introduction
99
:target: https://discord.gg/nBQh6qu
1010
:alt: Discord
1111

12-
.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_ServoKit.svg?branch=master
13-
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_ServoKit
12+
.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_ServoKit.svg?branch=master
13+
:target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_ServoKit
1414
:alt: Build Status
1515

1616
CircuitPython helper library for the PWM/Servo FeatherWing, Shield and Pi HAT and Bonnet kits.
@@ -27,6 +27,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2727
This is easily achieved by downloading
2828
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2929

30+
Installing from PyPI
31+
--------------------
32+
33+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
34+
PyPI <https://pypi.org/project/adafruit-circuitpython-servokit/>`_. To install for current user:
35+
36+
.. code-block:: shell
37+
38+
pip3 install adafruit-circuitpython-servokit
39+
40+
To install system-wide (this may be required in some cases):
41+
42+
.. code-block:: shell
43+
44+
sudo pip3 install adafruit-circuitpython-servokit
45+
46+
To install in a virtual environment in your current project:
47+
48+
.. code-block:: shell
49+
50+
mkdir project-name && cd project-name
51+
python3 -m venv .env
52+
source .env/bin/activate
53+
pip3 install adafruit-circuitpython-servokit
54+
3055
Usage Example
3156
=============
3257

‎setup.py‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
"""A setuptools based setup module.
2+
3+
See:
4+
https://packaging.python.org/en/latest/distributing.html
5+
https://github.com/pypa/sampleproject
6+
"""
7+
8+
# Always prefer setuptools over distutils
9+
from setuptools import setup, find_packages
10+
# To use a consistent encoding
11+
from codecs import open
12+
from os import path
13+
14+
here = path.abspath(path.dirname(__file__))
15+
16+
# Get the long description from the README file
17+
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
18+
long_description = f.read()
19+
20+
setup(
21+
name='adafruit-circuitpython-servokit',
22+
23+
use_scm_version=True,
24+
setup_requires=['setuptools_scm'],
25+
26+
description='CircuitPython helper library for PWM/Servo FeatherWing, Shield, and '
27+
'Pi HAT and Bonnet kits.',
28+
long_description=long_description,
29+
long_description_content_type='text/x-rst',
30+
31+
# The project's main homepage.
32+
url='https://github.com/adafruit/Adafruit_CircuitPython_ServoKit',
33+
34+
# Author details
35+
author='Adafruit Industries',
36+
author_email='[email protected]',
37+
38+
install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice',
39+
'adafruit-circuitpython-register', 'adafruit-circuitpython-pca9685',
40+
'adafruit-circuitpython-motor'],
41+
42+
# Choose your license
43+
license='MIT',
44+
45+
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
46+
classifiers=[
47+
'Development Status :: 3 - Alpha',
48+
'Intended Audience :: Developers',
49+
'Topic :: Software Development :: Libraries',
50+
'Topic :: System :: Hardware',
51+
'License :: OSI Approved :: MIT License',
52+
'Programming Language :: Python :: 3',
53+
'Programming Language :: Python :: 3.4',
54+
'Programming Language :: Python :: 3.5',
55+
],
56+
57+
# What does your project relate to?
58+
keywords='adafruit servo motor pwm pca9685 featherwing pi shield bonnet servokit kit i2c '
59+
'hardware micropython circuitpython',
60+
61+
# You can just specify the packages manually here if your project is
62+
# simple. Or you can use find_packages().
63+
py_modules=['adafruit_servokit'],
64+
)

0 commit comments

Comments
 (0)