Metadata-Version: 2.1
Name: akhq.py
Version: 0.0.1
Summary: A Python wrapper for the AKHQ API
Author-email: Theo Nard <theo.nard18@gmail.com>
Keywords: akhq,api,wrapper,python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: requests ==2.31.0

<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/PandeoF1/akhq.py">
    <img src="https://github.com/tchiotludo/akhq/blob/dev/client/src/images/logo_black.svg" alt="Logo" width="80" height="80">
  </a>

<h3 align="center">AKHQ.py</h3>

  <p align="center">
    AKHQ wrapper for Python
  </p>
</div>


## About The Project

This is a Python wrapper for the AKHQ API. It allows you to interact with the AKHQ API using Python.

[AKHQ](https://github.com/tchiotludo/akhq)

### Prerequisites

Create a virtual environment using the following command:

* venv
  ```sh
  python3 -m venv venv && source venv/bin/activate
  ```

* pip
  ```sh 
  pip install -r requirements.txt
  ```

or use the devcontainer provided in the repository.

### Dependencies

* [Python](https://www.python.org/)
* [requests](https://docs.python-requests.org/en/master/) - HTTP library for Python

## Installation

* From pypi
  ```sh
  pip install akhq.py
  ```

* From source
  ```sh
  pip install .
  ```

<!-- CONTRIBUTING -->
## Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

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

