edp-redy-api 1.1.2

EDP Redy API

Edp Redy

EDP Redy API
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • The Reason Behind
   • Interface
   • Wiring
   • Uart Pinout and Configuration
   • Protocol
   • Frames
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About the Project

The Reason Behind

(back to top)

Getting Started

Prerequisites

Installation

The installation of the library, including the CLI, is as simple as run:

$ pip install .

(back to top)

Usage

(back to top)

Roadmap

• Complete documentation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

To contribute to this project, you need to execute the following steps:

1. Install

   1. Create a virtual environment (see how to here):

   2. Activate the virtual environment (see how to here):

   3. Install all the requirements for development:

      pip install -e ".[dev]"

   4. Install pre-commit:

      pre-commit install

2. Create new feature and commit the changes

   1. Create a new feature branch based from the main branch:

      git checkout -b feature/<feature_name>

   2. Implement the changes for the feature

   3. Run formatters/linters:

      1. Ruff

         ruff .

      2. Mypy:

         mypy src/ tests/

   4. Commit the changes (this should run pre-commit to format/lint anyway)

(back to top)

License

Distributed under the Apache License Version 2.0. See LICENSE.txt for more information.

(back to top)

Contact

Hugo Gomes - [e-mail]

Project Link: https://github.com/hgomes88/edp-redy

Pipy Releases: https://pypi.org/project/edp-redy-api

(back to top)

Acknowledgments

• [othneildrew] Best Readme Template

(back to top)