Skip to content

PyPI setup. #6

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

Merged
merged 2 commits into from
Dec 28, 2018
Merged
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
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
*.mpy
.idea
__pycache__
_build
*.pyc
.env
build*
bundles
*.DS_Store
.eggs
dist
**/*.egg-info
41 changes: 20 additions & 21 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -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: V9+bzrCjRXViPtlIDiWvNaRKsTPWBjdCmwz+d8VyfNzFpIlEdc0Ly4+BICpvBbq32garHZxdkzYrMx8L2SidLGLRXtAD3yJvGSdaE0RwnQ94H6xs8k7+sEGE5acupcDdqgZxH+8rhTBs1/VtT4t7iQsebDg2hFYkosFIQnIiAkA0NAEv8KebbZsCXNV6ffk4VtiJe/2xkSiMuwcHrVjq6WwE2TIggNYTNVAdfZsI5R5/0E9j+R5+dV3MIpFfJ9xKad/jji5H0F9Sg7gOoK+gyOyUCNTATminMyPmY+wpXSfFt2SyMYBJePkva4ay2xZy13nuwvlPZuBRawKgQ0jSSLYONU6CbJbYAK29+moa0mdJU9Z1Xh9hljMFH6EKRtMT0CBGa1eyzpPNVdNe3idN2Ky1wfXIE2DdiTQKufXQLmbzJGobdar/frJXlm+YMLzJybYcfGN0VoTmRZi25laEi2bkepdQmYGIBhh4IdPBKDzqfMPHFIj9SFuNfSAALUoexAWCoD1clKP7e38AEd3uLEunXqNZpMYKiISjzAf4dGq3bQtEwd2mgtdqgvAo8oiQultl9zQcDjiTgPyvbp/TIdagVtU5O6NQcWOIO2WQzKDzx4cGAYji7Rz1OJQRW9+JkJxE8ssi/ymFUjDeGXy/zXNpiufTEOpIruT5QsUhvNE=
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_sharpmemorydisplay.py
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sharpmemorydisplay --library_location .
- cd docs && sphinx-build -E -W -b html . _build/html && cd ..
- pylint adafruit_sharpmemorydisplay.py
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace
examples/*.py)
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sharpmemorydisplay
--library_location .
- cd docs && sphinx-build -E -W -b html . _build/html && cd ..
29 changes: 27 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -9,8 +9,8 @@ Introduction
:target: https://discord.gg/nBQh6qu
:alt: Discord

.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_SHARPMemoryDisplay.svg?branch=master
:target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_SHARPMemoryDisplay
.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_SharpMemoryDisplay.svg?branch=master
:target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_SharpMemoryDisplay
:alt: Build Status

A display control library for Sharp 'memory' displays
@@ -25,6 +25,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-sharpmemorydisplay/>`_. To install for current user:

.. code-block:: shell

pip3 install adafruit-circuitpython-sharpmemorydisplay

To install system-wide (this may be required in some cases):

.. code-block:: shell

sudo pip3 install adafruit-circuitpython-sharpmemorydisplay

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-sharpmemorydisplay

Usage Example
=============

60 changes: 60 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -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-sharpmemorydisplay',

use_scm_version=True,
setup_requires=['setuptools_scm'],

description='CircuitPython display control library for Sharp memory displays.',
long_description=long_description,
long_description_content_type='text/x-rst',

# The project's main homepage.
url='https://github.com/adafruit/Adafruit_CircuitPython_SharpMemoryDisplay',

# Author details
author='Adafruit Industries',
author_email='circuitpython@adafruit.com',

install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-framebuf'],

# 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 sharp memory display 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_sharpmemorydisplay'],
)