https://github.com/happyleavesaoc/python-voobly
https://github.com/happyleavesaoc/python-voobly
api python voobly
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/happyleavesaoc/python-voobly
- Owner: happyleavesaoc
- License: mit
- Created: 2017-10-04T18:32:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T12:33:53.000Z (about 5 years ago)
- Last Synced: 2024-10-11T09:30:05.520Z (7 months ago)
- Topics: api, python, voobly
- Language: Python
- Size: 28.3 KB
- Stars: 6
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/voobly)
# python-voobly
Python 3 API for [Voobly](http://www.voobly.com), an online gaming platform. Makes requests to Voobly's public HTTP-based API.
## Prerequisites
- Active Voobly account
- API key provided by Voobly
## Install
`pip install voobly`
## Usage
See the [Voobly API documentation](http://www.voobly.com/pages/view/147/External-API-Documentation) for available parameters.
```python
import datetime
import voobly
# Establish a session. Use the API key provided by Voobly.
session = voobly.get_session(key="", cache_expiry=datetime.timedelta(days=1))
# optionally, supply username and password (for match access only):
session = voobly.get_session(username="", password="")
# Validate API key
assert voobly.validate_key(session) == True
# Get top accounts on AoC "RM - 1v1" ladder
top_accounts = voobly.get_ladder(session, 131) # returns list
top_accounts = voobly.get_ladder(session, "RM - 1v1") # same list
# Get lobby information for AoC
lobbies = voobly.get_lobbies(session, 13) # returns list
lobbies = voobly.get_ladders(session, "Age of Empires II: The Conquerors") # same list
# Look up a user ID based on username
uid = vooby.find_user("TheViper") # returns 123211439
# Look up user IDs for multiple usernames
results = voobly.find_users(session, "TheViper", "MBLAoC") # returns list
# Get user profile for "TheViper"
profile = voobly.get_user(session, 123211439)
profile = voobly.get_user(session, "TheViper") # same result
# Get match information
match = voobly.get_match(session, 18786853) # match id (last portion of URL), returns time played and rec links
# Download rec
filename = voobly.download_rec(session, "/files/view/50168753/9ogc...", "/save/to") # retrieve path from `get_match`
# The following methods are helpers built from the previous.
# Get a user profile & ladder info based on username
user = voobly.user("TheViper", ladder_ids=[131, 132]) # returns dict, ladder_ids may be names
# Get a list of ladder IDs for AoC
ladders = voobly.ladders(session, 13) # returns list
```
## Caveats
- `get_ladder` with a uid or uidlist does not return *global* ranking, only within results.
## Exception Handling
Exceptions raise a `VooblyError`, including connectivity issues, bad API key, and malformed results.
## Development
### Lint
`pylint voobly`
### Release
`make release`
### Contributions
Contributions are welcome. Please submit a PR that passes linting.
## Disclaimer
Not affiliated with Voobly.