SDK-2520: Add docs

This commit is contained in:
Romuald Juchnowicz-Bierbasz
2019-02-11 15:09:23 +01:00
parent 94b8c8d1a0
commit 0b9b2dc8d3

View File

@@ -1,2 +1,33 @@
# galaxy-plugin-api
# Galaxy python plugin API
## Usage
Implement plugin:
```python
import asyncio
from galaxy.api.plugin import Plugin
class PluginExample(Plugin):
# implement methods
async def authenticate(self, stored_credentials=None):
pass
# run plugin event loop
if __name__ == "__main__":
asyncio.run(MockPlugin().run())
```
Use [pyinstaller](https://www.pyinstaller.org/) to create plugin executbale.
## Development
Install required packages:
```bash
pip install -r requirments.txt
```
Run tests:
```bash
pytest
```