Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lesamouraipourpre/commedagh_circuitpython_pypi-version-testing

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/lesamouraipourpre/commedagh_circuitpython_pypi-version-testing
Owner: lesamouraipourpre
License: mit
Created: 2021-06-07T21:56:03.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-06-08T21:09:47.000Z (over 3 years ago)
Last Synced: 2024-10-11T22:41:08.170Z (about 1 month ago)
Language: Python
Size: 64.5 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        Introduction

============

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/lesamouraipourpre/Commedagh_CircuitPython_pypi-version-testing/workflows/Build%20CI/badge.svg

    :target: https://github.com/lesamouraipourpre/Commedagh_CircuitPython_pypi-version-testing/actions

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

testing pypi versioning

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_

or individual libraries can be installed using

`circup `_.

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 commedagh-circuitpython-pypi-version-testing

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

.. code-block:: shell

    sudo pip3 install commedagh-circuitpython-pypi-version-testing

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 commedagh-circuitpython-pypi-version-testing

Installing to a Connected CircuitPython Device with Circup

==========================================================

Make sure that you have ``circup`` installed in your Python environment.

Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install pypi-version-testing

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

=============

Add a quick, simple example. It and other examples should live in the

    examples folder and be included in docs/examples.rst.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.

Documentation

=============

For information on building library documentation, please check out

`this guide `_.