A Python 3 module wrapper for RuneScape 3 Clan's API
Project description
# rs3clans.py
A Python 3 module wrapper for RuneScape 3 Clan's API
Current Version: 0.3
***
## Setup:
```bash
python3 -m pip install rs3clans
```
***
### Usage:
* Import:
```python3
import rs3clans
```
***
* Getting a full clan list (type: csv.reader):
```python
rs3clans.get_clan_list('clan_name')
```
- You can iterate through clan lists as you normally would
***
* Getting a clan's total exp (type: int):
```python
rs3clans.get_clan_exp('clan_name')
```
***
* Getting a user's total clan exp (type: int):
```python
rs3clans.get_user_clan_exp('user_name', 'clan_name')
```
***
* Getting a user's clan rank (type: string):
```python
rs3clans.get_user_rank('user_name', 'clan_name')
```
***
* Getting a user's clan Name, Rank, Clan Exp and Kills (type: list)
```python
rs3clans.get_user_info('user_name', 'clan_name')
```
- You can use specific elements of the list as you normally would or use it as whole
***
* Getting the total player count of a Clan (type: int):
```python
rs3clans.get_player_count('clan_name')
```
***
* Getting the average clan exp per player in a Clan (type: float):
```python
get_average_clan_exp('clan_name')
```
A Python 3 module wrapper for RuneScape 3 Clan's API
Current Version: 0.3
***
## Setup:
```bash
python3 -m pip install rs3clans
```
***
### Usage:
* Import:
```python3
import rs3clans
```
***
* Getting a full clan list (type: csv.reader):
```python
rs3clans.get_clan_list('clan_name')
```
- You can iterate through clan lists as you normally would
***
* Getting a clan's total exp (type: int):
```python
rs3clans.get_clan_exp('clan_name')
```
***
* Getting a user's total clan exp (type: int):
```python
rs3clans.get_user_clan_exp('user_name', 'clan_name')
```
***
* Getting a user's clan rank (type: string):
```python
rs3clans.get_user_rank('user_name', 'clan_name')
```
***
* Getting a user's clan Name, Rank, Clan Exp and Kills (type: list)
```python
rs3clans.get_user_info('user_name', 'clan_name')
```
- You can use specific elements of the list as you normally would or use it as whole
***
* Getting the total player count of a Clan (type: int):
```python
rs3clans.get_player_count('clan_name')
```
***
* Getting the average clan exp per player in a Clan (type: float):
```python
get_average_clan_exp('clan_name')
```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
rs3clans-0.3.tar.gz
(3.0 kB
view hashes)