mirror of
https://github.com/gogcom/galaxy-integrations-python-api.git
synced 2026-02-06 04:51:31 -05:00
42 lines
712 B
Markdown
42 lines
712 B
Markdown
# 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 requirements.txt
|
|
```
|
|
|
|
Run tests:
|
|
```bash
|
|
pytest
|
|
```
|
|
|
|
## Changelog
|
|
|
|
### 0.16
|
|
* Do not log sensitive data.
|
|
### 0.15
|
|
* `shutdown()` is called on socket disconnection.
|
|
### 0.14
|
|
* Added required version parameter to Plugin constructor. |