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

https://github.com/wesgtox/denavit-hartenberg-api

API to determine the position of a robot's claw using the Denavit-Hartenberg model.
https://github.com/wesgtox/denavit-hartenberg-api

fastapi poetry-python python rest-api restful-api uvicorn

Last synced: 24 days ago
JSON representation

API to determine the position of a robot's claw using the Denavit-Hartenberg model.

Awesome Lists containing this project

README

          


Denavit-Hartenberg API



About  |  
Technology  |  
Getting Started  |  
Roadmap  |  
Contributing  |  
License


Denavit-Hartenberg API CI
codecov
GitHub top language
GitHub language count
GitHub last commit
GitHub issues
License

## About the Project

API to determine the position of a robot's claw using the Denavit-Hartenberg model.

## Technology

This project was developed with the following technologies:

- [Python](https://www.python.org/)
- [FastAPI](https://fastapi.tiangolo.com/)

## Getting Started

### Prerequisites

- [Python](https://www.python.org/downloads/)
- [Poetry](https://python-poetry.org/docs/#installation)

### Install and Run

1. Clone the repository:
```bash
git clone https://github.com/WesGtoX/denavit-hartenberg-api.git
```
2. Install the dependencies:
```bash
poetry install
```
3. Run:
```bash
poetry run uvicorn app.main:app --reload
```

## Roadmap

See the [open issues](https://github.com/WesGtoX/denavit-hartenberg-api/issues) for a list of proposed features (and known issues).

## How to contribute

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project.
2. Create your Feature Branch `git checkout -b feat/my-feature`.
3. Commit your Changes `git commit -m 'feat: My new feature'`.
4. Push to the Branch `git push origin feat/my-feature`.
5. Open a Pull Request.

After the merge of your pull request is done, you can delete your branch.

## License

Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

---

Made with ♥ by [Wesley Mendes](https://wesleymendes.com.br/) :wave: