diff --git a/README.rst b/README.rst index 373468e..36fd5df 100644 --- a/README.rst +++ b/README.rst @@ -15,7 +15,6 @@ Introduction CircuitPython `displayio` driver for SSD1608-based ePaper displays - Dependencies ============= This driver depends on: @@ -26,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 `_. +Installing from PyPI +===================== + +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-ssd1608 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-ssd1608 + +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-ssd1608 + Usage Example ============= @@ -89,4 +113,5 @@ before contributing to help this project stay welcoming. Documentation ============= -For information on building library documentation, please check out `this guide `_. +For information on building library documentation, please check out `this guide +`_. diff --git a/requirements.txt b/requirements.txt index 5f97a2d..17a850d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,8 +2,4 @@ # # SPDX-License-Identifier: Unlicense -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - Adafruit-Blinka diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..10020aa --- /dev/null +++ b/setup.py @@ -0,0 +1,57 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +"""A setuptools based setup module. + +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +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-ssd1608", + use_scm_version=True, + setup_requires=["setuptools_scm"], + description="CircuitPython `displayio` drivers for SSD1608-based ePaper displays", + long_description=long_description, + long_description_content_type="text/x-rst", + # The project's main homepage. + url="https://github.com/adafruit/Adafruit_CircuitPython_SSD1608", + # Author details + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka"], + # 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 blinka circuitpython micropython ssd1608 displayio epd epaper", + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, + # CHANGE `py_modules=['...']` TO `packages=['...']` + py_modules=["adafruit_ssd1608"], +) diff --git a/setup.py.disabled b/setup.py.disabled deleted file mode 100644 index 78b5cc4..0000000 --- a/setup.py.disabled +++ /dev/null @@ -1,8 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -""" -This library is not deployed to PyPI. It is either a board-specific helper library, or -does not make sense for use on or is incompatible with single board computers and Linux. -"""