mirror of
https://github.com/gogcom/galaxy-integrations-python-api.git
synced 2026-01-18 03:38:15 -05:00
SDK-2520: Add docs
This commit is contained in:
33
README.md
33
README.md
@@ -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
|
||||
```
|
||||
Reference in New Issue
Block a user