Metadata-Version: 2.1
Name: sr.robot3
Version: 2021.0.0a0.dev0
Summary: Student Robotics API for Python 3
Home-page: https://github.com/sr-robot3
License: MIT
Author: Student Robotics
Author-email: kit-brain@studentrobotics.org
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Project-URL: Documentation, https://studentrobotics.org/docs
Project-URL: Repository, https://github.com/srobo/sr-robot3
Description-Content-Type: text/markdown

# sr.robot3

[![SROBO](https://circleci.com/gh/srobo/sr-robot3.svg?style=svg)](https://app.circleci.com/pipelines/github/srobo/sr-robot3/)
[![Maintainability](https://api.codeclimate.com/v1/badges/a25bdecbca1477c2d72e/maintainability)](https://codeclimate.com/github/srobo/sr-robot3/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/a25bdecbca1477c2d72e/test_coverage)](https://codeclimate.com/github/srobo/sr-robot3/test_coverage)

Student Robotics API for Python 3

This package uses [PEP420]()-style namespace packaging.

## Development

### Requirements

This project uses the [Poetry](https://python-poetry.org) dependency and virtualenv manager.

You will also need:

- Python 3.6+
- Make

### Setup

- Clone the repository from GitHub to a folder on your local machine
- `cd` to that folder, and tell Poetry to install dependencies and set up a virtualenv `poetry install`
- You can now enter the virtual environment using `poetry shell` and develop using your IDE of choice.

### Tests

The full type, test and lint suite can be run using make: `make`.

You can also run parts of the suite.

- Unit tests: `make test`
- Unit tests with HTML coverage: `make test-cov`
- Linting: `make lint`
- Static type checks: `make type`

## Contributions

This project is released under the MIT Licence. For more information, please see LICENSE.

The CONTRIBUTORS file can be generated by executing CONTRIBUTORS.gen. This generated file contains a list of people who have contributed to sr.robot3.

