Skip to content
Super-slim image decoder that loads code as needed to minimize memory use
Branch: master
Clone or download
tannewt Merge pull request #15 from tannewt/fix_one_bit
Fix loading one bit images with non /8 width
Latest commit 42db804 Jun 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_imageload
docs Merge branch 'master' of github.com:adafruit/Adafruit_CircuitPython_I… May 15, 2019
examples Add example image. Jun 13, 2019
tests Move tests so that they don't get bundled May 31, 2019
.gitignore remove vscode May 11, 2019
.pylintrc ignore test folder for pylint May 12, 2019
.readthedocs.yml Initial version that can load indexed BMP files. Aug 30, 2018
.travis.yml Update test command for travis May 31, 2019
CODE_OF_CONDUCT.md Initial version that can load indexed BMP files. Aug 30, 2018
LICENSE Initial version that can load indexed BMP files. Aug 30, 2018
README.rst fix the build May 14, 2019
requirements.txt Initial version that can load indexed BMP files. Aug 30, 2018

README.rst

Introduction

Documentation Status Discord Build Status

This library decodes an image file into new bitmap and palette objects of the provided type. It's designed to load code needed during decoding as needed. This is meant to minimize the memory overhead of the decoding code.

Usage Example

.. literalinclude:: ../examples/imageload_simpletest.py

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-imageload --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.