https://github.com/timeplus-io/gluon

Python SDK for Timeplus REST API (not for Proton)
https://github.com/timeplus-io/gluon

Last synced: about 1 year ago
JSON representation

Python SDK for Timeplus REST API (not for Proton)

• Host: GitHub
• URL: https://github.com/timeplus-io/gluon
• Owner: timeplus-io
• License: apache-2.0
• Created: 2022-03-11T22:53:25.000Z (over 4 years ago)
• Default Branch: develop
• Last Pushed: 2024-09-01T18:05:57.000Z (almost 2 years ago)
• Last Synced: 2025-04-14T19:04:53.910Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 2.71 MB
• Stars: 3
• Watchers: 5
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gluon

Timeplus API SDK for Python

![Timeplus SDK](sdk.png)

A `gluon` (/ˈɡluːɒn/) is an elementary particle that acts as the exchange particle (or gauge boson) for the strong force between quarks. It is analogous to the exchange of photons in the electromagnetic force between two charged particles.

In Timepluse architecture, `gluon` is the API sdk acting as the connection to Timeplus's ecosystems.

# Python SDK

Please check the README in [python](https://github.com/timeplus-io/gluon/tree/develop/python) folder.

# development

## update api

1. update `spec/swagger.yaml` with the latest neutron api spec

2. `make gen`

3. manually update query: https://github.com/timeplus-io/gluon/blob/fbd30bd1dddfecc5ea10f7fe282f720618cab73e/python/swagger_client/timeplus/queries_v1beta2_api.py#L140 set `_preload_content` to `False`

4. manully update `swagger_client/rest.py` https://github.com/timeplus-io/gluon/commit/201cf464a7461ff31d34850753922c21f7fbeadb, make sure the string body wont get dumped again

5. disable `None` check in `swagger_client/models/alert` for `@trigger_query.setter` and `@resolve_query.setter`

6. go to `python` folder, set env properly and then `make test`

7. `make format` to format the code

## test

Manually try the sample in `examples`