OGS Python Library
Summary
An API wrapper written in python for the Online-Go Server's (OGS) REST API and Realtime (SocketIO) API
NOTE While the project is mostly functional, this is still a work in progress, and is not yet ready for production use.
Documentation
The documentation is built automatically using mkdocs and mkdocstrings.
Read the documentation here for more info: https://ogs-python.dakotamarshall.net/
Install
Pip Package
python3 -m pip install ogsapi
Manual
Installing the specific versions in requirements.txt is REQUIRED, the OGS API does not support newer versions, and these versions of socketio and engineio are tested to be compatible with each other.
pip3 install -r requirements.txt
If you install the wrong version by accident, you must uninstall and re-install.
pip3 uninstall python-engineio python-socketio
pip3 install -r requirements.txt
Usage
from ogsapi.client import OGSClient
ogs = OGSClient('your_client_id', 'your_client_secret', 'your_username', 'your_password')
This will authenticate you to OGS using your API credentials, and connect you to the Realtime API Socket. You can now call the usable functions.
Implemented API Functions
NOTE All usernames are case sensitive
Look at the documentation to see what methods are available under OGSClient and OGSSocket / OGSGame
See the checklist for a rough list of what is left to be implemented
1 maintainer
Metadata
1 maintainer
Release files for ogsapi 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ogsapi-1.3.0.tar.gz | 52.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ogsapi-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 97.9 kB
Release files / ogsapi-1.3.0.tar.gz
| Download URL | ogsapi-1.3.0.tar.gz |
|---|---|
| Size | 52.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eb2b6861183fbbb517d8ee236f34fd46e8d364060563bf25914c1484128b5246
|
|
BLAKE2b-256 checksum How to use checksums |
f3d38821a2c6adc29ff92cea48fd3d527c1cd099f156c1a76b0966e5b433809c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Release files / ogsapi-1.3.0-py3-none-any.whl
| Download URL | ogsapi-1.3.0-py3-none-any.whl |
|---|---|
| Size | 45.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b248082f2e1ace075934ecb3bf93ebe68018d03290877e60e76f6adf97b08449
|
|
BLAKE2b-256 checksum How to use checksums |
772a55bdc5cd476d39bca8aadcabe6a34054ae63b6e1e9e2e2c56843856439cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Security for ogsapi 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
