Welcome to I2C LCD’s documentation!

Contents:

I2C LCD

https://img.shields.io/pypi/v/i2c_lcd.svg https://img.shields.io/travis/pwlandoll/i2c_lcd.svg Documentation Status Updates

I2C LCD interface in Python made for RPi.

Features

  • Interface with I2C-connected LCD screens, by means of the SMBus, most commonly with Raspberry Pi boards.
  • Display text on the screen, given as a string or characters.

Credits

The code in this package is based almost entirely on code by DenisFromHR (Denis Pleic), taken 2017-3-26 from GitHub Gists.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install I2C LCD, run this command in your terminal:

$ pip install i2c_lcd

This is the preferred method to install I2C LCD, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for I2C LCD can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/pwlandoll/i2c_lcd

Or download the tarball:

$ curl  -OL https://github.com/pwlandoll/i2c_lcd/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use I2C LCD in a project:

import i2c_lcd
lcd = i2c_lcd.lcd()

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/pwlandoll/i2c_lcd/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

I2C LCD could always use more documentation, whether as part of the official I2C LCD docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/pwlandoll/i2c_lcd/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up i2c_lcd for local development.

  1. Fork the i2c_lcd repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/i2c_lcd.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv i2c_lcd
$ cd i2c_lcd/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 i2c_lcd tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/pwlandoll/i2c_lcd/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_i2c_lcd

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.0 (2017-05-29)

  • First release on PyPI.

Indices and tables