mirror of
https://github.com/nikdoof/grumble.git
synced 2025-12-11 16:02:14 +00:00
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
Grumble
|
|
=======
|
|
|
|
A Small, RESTful API wrapper for Mumble servers.
|
|
|
|
The aim is to make a simple Flask based RESTful API to reduce the effort and development time needed to interface with Mumble servers for simple administration tasks. The API will cover the majority of the available ICE RPC functions in Mumble, excluding the callback functionality.
|
|
|
|
This application is still under heavy development and it is suggested you do not use it within a production environment.
|
|
|
|
|
|
Requirements
|
|
------------
|
|
|
|
Grumble makes use of a few existing libraries and tools to make development:
|
|
|
|
* Flask
|
|
* Flask-RESTful
|
|
* MumblePy
|
|
|
|
All dependencies are covered by either the `setup.py` or `requirements.txt`
|
|
|
|
|
|
Mumble Support
|
|
--------------
|
|
|
|
At the moment Grumble supports the current stable Murmur server, version 1.2.4. This version is required for the ICE Slice file introspection used during connection setup.
|
|
|
|
|
|
Development Environment
|
|
-----------------------
|
|
|
|
Grumble makes use of Vagrant for its development environment and a simple configuration has been provided to bootstrap a Ubuntu VM running a basic Mumble server.
|
|
|
|
To initialize the VM run `vagrant up` in the project root directory.
|