Metadata-Version: 2.4
Name: pynnacle_genesis
Version: 1.1.2
Summary: A Python module for the Pinnacle Genesis board, offering hands-on robotics coding with a familiar structure inspired by popular development board environments.
Home-page: https://github.com/Red-Pula/pynnacle-genesis
Author: Rafael Red Angelo M. Hizon, Jenel M. Justo, Serena Mae C.S. Lee
Author-email: redhizon@gmail.com, jenel.just88@gmail.com, nmae.lee@gmail.com
License: GNU Affero General Public License
Classifier: Intended Audience :: Education
Classifier: Topic :: Education
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pymata4>=1.15
Requires-Dist: pyserial>=3.5
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

<img src="https://raw.githubusercontent.com/Red-Pula/pynnacle-genesis/main/assets/banner.png" alt="Pinnacle Robotics Logo" width="1920"/>

# pynnacle-genesis

[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.html)
[![Python Version](https://img.shields.io/badge/python-3.7%2B-blue.svg)](https://www.python.org/)
[![PyPI version](https://img.shields.io/pypi/v/pynnacle-genesis.svg)](https://pypi.org/project/pynnacle-genesis/)
[![PyPI downloads](https://img.shields.io/pypi/dm/pynnacle-genesis.svg)](https://pypi.org/project/pynnacle-genesis/)

## Introduction

The **pynnacle-genesis** package was originally created as a learning companion for readers of **_Python Odyssey: Into the World of Robotics_** by Pinnacle Robotics, alongside the **Pinnacle Genesis** board featured in the book.

It provides an abstraction layer, allowing newcomers to write Python code for various projects in a way that feels both intuitive and approachable. At the same time, it builds familiarity that helps ease the transition to advanced and popular platforms in the future. Our goal is simple but ambitious: **make robotics programming less intimidating and more inspiring**. By lowering the learning curve, we help students and hobbyists quickly connect software with hardware, turning curiosity into creation.

**See what learners have achieved with pynnacle-genesis**: [Pinnacle Robotics on Facebook](https://www.facebook.com/pinnaclerobotics).

<img src="https://raw.githubusercontent.com/Red-Pula/pynnacle-genesis/main/assets/qr-code.png" alt="Pinnacle Robotics QR Code" width="150"/>

## Compatibility

The **pynnacle-genesis** package is **specifically designed and tested exclusively with the Pinnacle Genesis board**, ensuring reliable compatibility and full functionality. While it may appear to work with other development boards, these have not been tested. Using it outside the intended board may result in **limited features, reduced stability, or unexpected behavior**.

For the best experience, use this package with the **Pinnacle Genesis** board.

## Installation

`pip install pynnacle-genesis`

## Acknowledgements

The **pynnacle-genesis** project is brought to you by **Team Pinnacle:**

1. **Red Hizon**
2. **Jenel Justo**
3. **Serena Lee**

Our mission is to make robotics and programming education accessible, intuitive, and empowering for beginners everywhere. We deeply value the contributions of the open-source community, and to create high-level abstractions that bridge hardware and software, this project utilizes and hides the complexities of libraries such as pyserial by Chris Liechti and pymata4 by Alan Yorinks. We hope that everyone using this library will be inspired to contribute back and help grow the body of knowledge.

### Attribution Notice

If you use **pynnacle-genesis** in teaching, research, or projects, please acknowledge **Team Pinnacle** and reference this repository. It helps share knowledge widely and inspires others to explore, learn, and create in the field of robotics and programming.

**Suggested Format:**

```
This project uses pynnacle-genesis by Team Pinnacle (Red Hizon, Jenel Justo, and Serena Lee).
Explore the repository and create your own projects: https://github.com/Red-Pula/pynnacle-genesis
```

## License

This project is licensed under the **AGPL-3.0**.

For details, see the full [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.html).
