Skip to content

Commit 23dbf14

Browse files
Enable uploading of the driver to PyPI
1 parent 44398c8 commit 23dbf14

File tree

4 files changed

+84
-14
lines changed

4 files changed

+84
-14
lines changed

README.rst

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ Introduction
1515

1616
CircuitPython `displayio` driver for SSD1608-based ePaper displays
1717

18-
1918
Dependencies
2019
=============
2120
This driver depends on:
@@ -26,6 +25,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2625
This is easily achieved by downloading
2726
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2827

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

@@ -89,4 +113,5 @@ before contributing to help this project stay welcoming.
89113
Documentation
90114
=============
91115

92-
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
116+
For information on building library documentation, please check out `this guide
117+
<https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

requirements.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,4 @@
22
#
33
# SPDX-License-Identifier: Unlicense
44

5-
# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
6-
#
7-
# SPDX-License-Identifier: Unlicense
8-
95
Adafruit-Blinka

setup.py

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
2+
#
3+
# SPDX-License-Identifier: MIT
4+
5+
"""A setuptools based setup module.
6+
7+
See:
8+
https://packaging.python.org/en/latest/distributing.html
9+
https://github.com/pypa/sampleproject
10+
"""
11+
12+
from setuptools import setup, find_packages
13+
14+
# To use a consistent encoding
15+
from codecs import open
16+
from os import path
17+
18+
here = path.abspath(path.dirname(__file__))
19+
20+
# Get the long description from the README file
21+
with open(path.join(here, "README.rst"), encoding="utf-8") as f:
22+
long_description = f.read()
23+
24+
setup(
25+
name="adafruit-circuitpython-ssd1608",
26+
use_scm_version=True,
27+
setup_requires=["setuptools_scm"],
28+
description="CircuitPython `displayio` drivers for SSD1608-based ePaper displays",
29+
long_description=long_description,
30+
long_description_content_type="text/x-rst",
31+
# The project's main homepage.
32+
url="https://github.com/adafruit/Adafruit_CircuitPython_SSD1608",
33+
# Author details
34+
author="Adafruit Industries",
35+
author_email="[email protected]",
36+
install_requires=["Adafruit-Blinka"],
37+
# Choose your license
38+
license="MIT",
39+
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
40+
classifiers=[
41+
"Development Status :: 3 - Alpha",
42+
"Intended Audience :: Developers",
43+
"Topic :: Software Development :: Libraries",
44+
"Topic :: System :: Hardware",
45+
"License :: OSI Approved :: MIT License",
46+
"Programming Language :: Python :: 3",
47+
"Programming Language :: Python :: 3.4",
48+
"Programming Language :: Python :: 3.5",
49+
],
50+
# What does your project relate to?
51+
keywords="adafruit blinka circuitpython micropython ssd1608 displayio epd epaper",
52+
# You can just specify the packages manually here if your project is
53+
# simple. Or you can use find_packages().
54+
# TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
55+
# CHANGE `py_modules=['...']` TO `packages=['...']`
56+
py_modules=["adafruit_ssd1608"],
57+
)

setup.py.disabled

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)