Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Latest commit 757b8c3 Dec 22, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples
.gitignore PyPI setup. Nov 19, 2018
.pylintrc
.readthedocs.yml Initial commit. Nov 16, 2018
.travis.yml PyPI setup. Nov 19, 2018
CODE_OF_CONDUCT.md
LICENSE Initial commit. Nov 16, 2018
README.rst change 'travis-ci.org' to 'travis-ci.com' Dec 21, 2018
adafruit_74hc595.py Linting. Nov 16, 2018
requirements.txt Initial commit. Nov 16, 2018
setup.py PyPI setup. Nov 19, 2018

README.rst

Introduction

Documentation Status Discord Build Status

CircuitPython driver for 74HC595 shift register.

Dependencies

This driver depends on:

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:

pip3 install adafruit-circuitpython-74hc595

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

sudo pip3 install adafruit-circuitpython-74hc595

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-74hc595

Usage Example

import board
import adafruit_74hc595
import busio
import digitalio
import time

spi = busio.SPI(board.SCK, MOSI=board.MOSI)

latch_pin = digitalio.DigitalInOut(board.D5)
sr = adafruit_74hc595.ShiftRegister74HC595(spi, latch_pin)

pin1 = sr.get_pin(1)

while True:
pin1.value = True
time.sleep(1)
pin1.value = False
time.sleep(1)

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-74hc595 --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.