https://github.com/arraial/pipo-dispatch
Pipo service handling hub requests forwarding to services
https://github.com/arraial/pipo-dispatch
bot discord music
Last synced: about 2 months ago
JSON representation
Pipo service handling hub requests forwarding to services
- Host: GitHub
- URL: https://github.com/arraial/pipo-dispatch
- Owner: arraial
- License: mit
- Created: 2024-10-23T17:00:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-18T22:11:36.000Z (over 1 year ago)
- Last Synced: 2025-01-24T21:31:50.374Z (over 1 year ago)
- Topics: bot, discord, music
- Language: Python
- Homepage:
- Size: 56.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pipo_dispatch
[](https://opensource.org/licenses/MIT)
[](https://github.com/arraial/pipo-dispatch/actions/workflows/docker.yml)
[](https://github.com/arraial/pipo-dispatch/releases)
[](https://hub.docker.com/r/arraial/pipo_dispatch)
[](https://python-poetry.org/)
[](https://www.sphinx-doc.org/)
Pipo service responsible for forward hub requests to services
## Installation
### Runtime prerequisites
The application is compatible with Windows and Linux based systems.
[Docker](https://docs.docker.com/engine/install/) + [Docker Compose](https://docs.docker.com/compose/install/) are assumed to be installed and configured.
### Development
One may leverage VS Code Devcontainer for a simplified setup or other suitable option, as describbed in [Manual Setup](#manual).
#### Visual Studio Devcontainer
Devcontainer functionality can be used by choosing option `Dev Containers: Open Folder in Container...` in VS Code.
#### Manual Setup
For these guiding steps a [compatible version](pyproject.toml) of Python is assumed to be installed.
In case poetry is not locally installed:
```bash
make poetry_setup
```
To setup the development environment and being able to run the test suite do:
```bash
make dev_setup
```
Build the app container image with:
```bash
make image
```
For additional help try:
```bash
make help
```
## How to run
### Test suite
Before running the suite make sure file `/tests/.secrets.yaml` was created and filled based on the available [example](.secrets.example.yaml).
```bash
make test
```
### Containerized application
Before running the following command make sure `.env` was created and filled based on the available [example](.env.example).
Start the container with
```bash
make run_image
```
## License
This project is licensed under the MIT License - see [LICENSE](LICENSE) file for details.