Skip to content

Commit

Permalink
add 3.6 in tests configuration & badges to README
Browse files Browse the repository at this point in the history
  • Loading branch information
fsoubelet committed Jan 6, 2021
1 parent 5c83138 commit 5e024fd
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cron.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-16.04, ubuntu-18.04, ubuntu-20.04, macos-latest, windows-latest]
python-version: [3.7, 3.8, 3.9, 3.x] # crons should always run latest python hence 3.x
python-version: [3.6, 3.7, 3.8, 3.9, 3.x] # crons should always run latest python hence 3.x

steps:
- uses: actions/checkout@v2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-16.04, ubuntu-18.04, ubuntu-20.04, macos-latest, windows-latest]
python-version: [3.7, 3.8, 3.9]
python-version: [3.6, 3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v2
Expand Down
65 changes: 62 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,66 @@
<b>aoe2netwrapper</b>
</h1>

A simple typed wrapper to interact with the APIs provided by https://aoe2.net.
<p align="center">
<!-- PyPi Version -->
<a href="https://pypi.org/project/aoe2netwrapper">
<img alt="PyPI Version" src="https://img.shields.io/pypi/v/aoe2netwrapper?label=PyPI&logo=PyPI">
</a>

<!-- Github Release -->
<a href="https://github.com/fsoubelet/AoE2NetAPIWrapper/releases">
<img alt="Github Release" src="https://img.shields.io/github/v/release/fsoubelet/AoE2NetAPIWrapper?color=orange&label=Release&logo=Github">
</a>

<br/>

<!-- Github Actions Build -->
<a href="https://github.com/fsoubelet/AoE2NetAPIWrapper/actions?query=workflow%3A%22Cron+Testing%22">
<img alt="Github Actions" src="https://github.com/fsoubelet/AoE2NetAPIWrapper/workflows/Cron%20Testing/badge.svg">
</a>

<!-- Code Coverage -->
<a href="https://codeclimate.com/github/fsoubelet/AoE2NetAPIWrapper/maintainability">
<img alt="Code Coverage" src="https://img.shields.io/codeclimate/maintainability/fsoubelet/AoE2NetAPIWrapper?label=Maintainability&logo=Code%20Climate">
</a>

<br/>

<!-- Code style -->
<a href="https://github.com/psf/Black">
<img alt="Code Style" src="https://img.shields.io/badge/Code%20Style-Black-9cf.svg">
</a>

<!-- Linter -->
<a href="https://github.com/PyCQA/pylint">
<img alt="Linter" src="https://img.shields.io/badge/Linter-Pylint-ce963f.svg">
</a>

<!-- Build tool -->
<a href="https://github.com/python-poetry/poetry">
<img alt="Build tool" src="https://img.shields.io/badge/Build%20Tool-Poetry-4e5dc8.svg">
</a>

<!-- Test runner -->
<a href="https://github.com/pytest-dev/pytest">
<img alt="Test runner" src="https://img.shields.io/badge/Test%20Runner-Pytest-ce963f.svg">
</a>

<!-- License -->
<a href="https://github.com/fsoubelet/AoE2NetAPIWrapper/blob/master/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/fsoubelet/AoE2NetAPIWrapper?color=9cf&label=License">
</a>
</p>

<p align="center">
A simple typed wrapper to interact with the https://aoe2.net APIs
</p>

<p align="center">
<a href="https://www.python.org/">
<img alt="Made With Python" src="https://forthebadge.com/images/badges/made-with-python.svg">
</a>
</p>

## Install

Expand All @@ -16,7 +75,7 @@ pip install aoe2netwrapper
The package provides a simple, fully-typed high-level object to interact with each API provided by `aoe2.net`.
Each exposed endpoint from the APIs can be queried with a method named after it:

* Complete data API:
* __Complete data API__
```python
from aoe2netwrapper import AoE2NetAPI

Expand All @@ -29,7 +88,7 @@ top_accounts = client.leaderboard(game="aoe2de", leaderboard_id=3, start=1, coun
open_lobbies = client.lobbies(game="aoe2de")
```

* Nightbot API:
* __Nightbot API__
```python
from aoe2netwrapper import AoE2NightbotAPI

Expand Down

0 comments on commit 5e024fd

Please sign in to comment.