{"id":20503052,"url":"https://github.com/dakota-marshall/python-ogs","last_synced_at":"2025-04-13T20:16:29.982Z","repository":{"id":148917596,"uuid":"610612584","full_name":"dakota-marshall/python-ogs","owner":"dakota-marshall","description":"A Python API Wrapper for the OGS API","archived":false,"fork":false,"pushed_at":"2023-10-09T23:59:50.000Z","size":352,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T20:16:09.187Z","etag":null,"topics":["api","baduk","foss","gogame","python","weiqi"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dakota-marshall.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-03-07T05:52:17.000Z","updated_at":"2024-10-06T16:46:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"f43b21ed-724d-4b64-ae3a-558ca3cc4575","html_url":"https://github.com/dakota-marshall/python-ogs","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dakota-marshall%2Fpython-ogs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dakota-marshall%2Fpython-ogs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dakota-marshall%2Fpython-ogs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dakota-marshall%2Fpython-ogs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dakota-marshall","download_url":"https://codeload.github.com/dakota-marshall/python-ogs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248774962,"owners_count":21159534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","baduk","foss","gogame","python","weiqi"],"created_at":"2024-11-15T19:29:02.646Z","updated_at":"2025-04-13T20:16:29.935Z","avatar_url":"https://github.com/dakota-marshall.png","language":"Python","readme":"# OGS Python Library\n\n\n[![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)\n\n[![github-sponsors](https://img.shields.io/badge/Sponsor-%E2%9D%A4-%23db61a2.svg?\u0026logo=github\u0026logoColor=white\u0026labelColor=181717\u0026style=flat-square)](https://github.com/sponsors/dakota-marshall)\n\n## Summary\n\nAn API wrapper written in python for the Online-Go Server's (OGS) REST API and Realtime (SocketIO) API\n\n**NOTE** While the project is mostly functional, this is still a work in progress, and is not yet ready for production use.\n\n## Documentation\n\nThe documentation is built automatically using mkdocs and mkdocstrings.\n\nRead the documentation here for more info: https://ogs-python.dakotamarshall.net/\n\n## Install\n\n### Pip Package\n\n```bash\npython3 -m pip install ogsapi\n```\n\n### Manual\n\nInstalling 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.\n\n```bash\npip3 install -r requirements.txt\n```\n\nIf you install the wrong version by accident, you *must* uninstall and re-install.\n\n```bash\npip3 uninstall python-engineio python-socketio\npip3 install -r requirements.txt\n```\n## Usage\n\n```python\nfrom ogsapi.client import OGSClient\n\nogs = OGSClient('your_client_id', 'your_client_secret', 'your_username', 'your_password')\n```\nThis will authenticate you to OGS using your API credentials, and connect you to the Realtime API Socket. You can now call the usable functions.\n\n## Implemented API Functions\n*NOTE* All usernames are case sensitive\n\nLook at the [documentation](https://ogs-python.dakotamarshall.net/api/) to see what methods are available under `OGSClient` and `OGSSocket` / `OGSGame`\n\nSee the [checklist](https://ogs-python.dakotamarshall.net/checklist) for a rough list of what is left to be implemented\n\n\u003ca rel=\"me\" href=\"https://firefish.social/@bonealisa\"\u003e\u003c/a\u003e","funding_links":["https://github.com/sponsors/dakota-marshall"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdakota-marshall%2Fpython-ogs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdakota-marshall%2Fpython-ogs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdakota-marshall%2Fpython-ogs/lists"}