Metadata-Version: 2.1
Name: argus_dynamixel
Version: 0.1.8
Summary: The dynamixel SDK wrapper for the Argus Array project
Author: Alan Vasquez
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: dynamixel-sdk (>=3.7.31,<4.0.0)
Requires-Dist: python-dotenv (>=1.0.1)
Description-Content-Type: text/markdown

<!-- PROJECT LOGO -->
<br />
<p align="center">
  <a href="https://github.com/vasqua/argus_dynamixel">
    <img src="images/logo.png" alt="Logo">
  </a>

  <h3 align="center">argus_dynamixel</h3>

  <p align="center">
    A python wraprapper with the necessary methods to enable dynamixel usage on Argus Array hardware
    <br />
    <a href="https://github.com/vasqua/argus_dynamixel"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/vasqua/argus_dynamixel">View Demo</a>
    ·
    <a href="https://github.com/vasqua/argus_dynamixel/issues">Report Bug</a>
    ·
    <a href="https://github.com/vasqua/argus_dynamixel/issues">Request Feature</a>
  </p>
</p>



<!-- TABLE OF CONTENTS -->
<details open="open">
  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgements">Acknowledgements</a></li>
  </ol>
</details>



<!-- ABOUT THE PROJECT -->
## About The Project

This is a blank README.md to be inserted into your Argus-HDPS project with CookieCutter. 

To use it, create a new package with: 

  ```sh
  cookiecutter git@github.com:argus-hdps/cookiecutter-argus-hdps.git    
  ```                                       
and enter a few parameters as prompted. Boom, you are ready to go with a bunch of sensible defaults!                                                                                                                         

### Built With
This is a list of the base packages that you should be familiar with to get ready 

* []()
* []()
* []()

<!-- GETTING STARTED -->
## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.
* [Poetry](https://python-poetry.org)_ 
* Python3.9 or later

### Installation

1. Clone the repo
   ```sh
   git clone https://github.com/vasqua/argus_dynamixel
   ```
2. Create the Poetry env
   ```sh
   cd argus_dynamixel/
   poetry install
   ```
3. Activate the shell, do whatever
  ```sh
  poetry shell
  poetry run ...
  ```




<!-- USAGE EXAMPLES -->
## Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_



<!-- ROADMAP -->
## Roadmap

See the [open issues](https://github.com/vasqua/argus_dynamixel/issues) for a list of proposed features (and known issues).



<!-- CONTRIBUTING -->
## Contributing

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 feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request



<!-- LICENSE -->
## License

Distributed under the MIT License. See `LICENSE` for more information.



<!-- CONTACT -->
## Contact

Alan Vasquez - vasqua@unc.edu

Project Link: [https://github.com/vasqua/argus_dynamixel](https://github.com/vasqua/argus_dynamixel)



<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements

* []()
* []()
* []()





<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
<!-- [contributors-shield]: https://img.shields.io/github/contributors/github_username/repo.svg?style=for-the-badge -->
<!-- [contributors-url]: https://github.com/github_username/repo/graphs/contributors -->
<!-- [forks-shield]: https://img.shields.io/github/forks/github_username/repo.svg?style=for-the-badge -->
<!-- [forks-url]: https://github.com/github_username/repo/network/members -->
<!-- [stars-shield]: https://img.shields.io/github/stars/github_username/repo.svg?style=for-the-badge -->
<!-- [stars-url]: https://github.com/github_username/repo/stargazers -->
<!-- [issues-shield]: https://img.shields.io/github/issues/github_username/repo.svg?style=for-the-badge -->
<!-- [issues-url]: https://github.com/github_username/repo/issues -->
<!-- [license-shield]: https://img.shields.io/github/license/github_username/repo.svg?style=for-the-badge -->
<!-- [license-url]: https://github.com/github_username/repo/blob/master/LICENSE.txt -->
<!-- [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 -->
<!-- [linkedin-url]: https://linkedin.com/in/github_username -->

