Skip to content
Logging module for CircuitPython
Python
Branch: master
Clone or download
tannewt Merge pull request #6 from magnusvmt/master
Example renamed to match repo name
Latest commit 8198cb6 Oct 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples
.gitignore Rearrange Mar 7, 2019
.pylintrc
.readthedocs.yml Rearrange Mar 7, 2019
.travis.yml
CODE_OF_CONDUCT.md Rearrange Mar 7, 2019
LICENSE
README.rst rename logging -> adafruit_logging Mar 13, 2019
adafruit_logging.py rename logging -> adafruit_logging Mar 13, 2019
requirements.txt Rearrange Mar 7, 2019
setup.py

README.rst

Introduction

Documentation Status Discord Build Status

Logging module for CircuitPython

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.

Usage Example

import adafruit_logging as logging

logger = logging.getLogger('test')

logger.setLevel(logging.ERROR)
logger.info('Info message')
logger.error('Error message')

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