https://github.com/dakota-marshall/python-ogs

A Python API Wrapper for the OGS API
https://github.com/dakota-marshall/python-ogs

api baduk foss gogame python weiqi

Last synced: about 1 month ago
JSON representation

A Python API Wrapper for the OGS API

• Host: GitHub
• URL: https://github.com/dakota-marshall/python-ogs
• Owner: dakota-marshall
• License: gpl-3.0
• Created: 2023-03-07T05:52:17.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-09T23:59:50.000Z (about 1 year ago)
• Last Synced: 2023-10-10T00:23:45.617Z (about 1 year ago)
• Topics: api, baduk, foss, gogame, python, weiqi
• Language: Python
• Homepage:
• Size: 344 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OGS Python Library

[![pipeline status](https://gitlab.com/dakota.marshall/ogs-python/badges/prod/pipeline.svg)](https://gitlab.com/dakota.marshall/ogs-python/-/commits/prod)  [![Latest Release](https://gitlab.com/dakota.marshall/ogs-python/-/badges/release.svg)](https://gitlab.com/dakota.marshall/ogs-python/-/releases) [![PyPI version](https://badge.fury.io/py/ogsapi.svg)](https://badge.fury.io/py/ogsapi) [![License](https://img.shields.io/gitlab/license/dakota.marshall%2Fogs-python)](./LICENSE) [![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](./CHANGELOG.md)

[![github-sponsors](https://img.shields.io/badge/Sponsor-%E2%9D%A4-%23db61a2.svg?&logo=github&logoColor=white&labelColor=181717&style=flat-square)](https://github.com/sponsors/dakota-marshall)

## 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

```bash

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.

```bash

pip3 install -r requirements.txt

```

If you install the wrong version by accident, you *must* uninstall and re-install.

```bash

pip3 uninstall python-engineio python-socketio

pip3 install -r requirements.txt

```

## Usage

```python

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](https://ogs-python.dakotamarshall.net/api/) to see what methods are available under `OGSClient` and `OGSSocket` / `OGSGame`

See the [checklist](https://ogs-python.dakotamarshall.net/checklist) for a rough list of what is left to be implemented