Merge pull request #47 from SharpBit/development

Development of v4.0.0

Author: SharpBit

.env.example

@@ -0,0 +1,2 @@
+token = # Replace this with your API token
+base_url = # Proxy server to handle requests to API due to IP limitations

CHANGELOG.md

@@ -1,13 +1,30 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [3.0.3] - 3/8/20
+## [4.0.0] - TBD
+### Added
+- `reason` attribute for `NotFoundError`
+### Removed
+- BrawlAPI client
+### Changed
+- `Client.get_datetime` moved to utils
+- `get_rankings` now requires all arguments to be keyword arguments
+### Fixed
+- Brawler leaderboard now works
+
+## [3.0.4] - 3/8/20
+### Changed
+- Leaderboard functions reverted to one function for all types of leaderboards/rankings
+
+## [3.0.3] - 2/17/20
 ### Added
 - `invalid_chars` attribute for `NotFoundError` when applicable
 - `url` attribute for all errors that have requested a URL
 - `str(error)` will return the message attribute of the error.
 ### Changed
 - The `error` attribute for all errors have been renamed to `message`
+- For BrawlAPI: `get_leaderboard` split up into `get_player_leaderboard`, `get_club_leaderboard`, and `get_brawler_leaderboard`
+- For the official API: `get_rankings` split up into `get_player_rankings`, `get_club_rankings`, and `get_brawler_rankings`
 
 ## [3.0.2] - 12/22/19
 ### Fixed

CONTRIBUTING.md

@@ -8,8 +8,8 @@
 6. Add the necessary tests in the `tests` folder
 7. Add the necessary documentation and docstrings
 8. Add the necessary points to `CHANGELOG.md`
-9. Fill up the `tests/.env` file with the suitable token(s)
-10. Run `tox` from the root folder and ensure the tests are configured correctly and they return OK. `ServerError` and `MaintenanceError` can be disregarded.
+9. Fill up the `.env` file
+10. Run `tox` from the root folder and ensure the tests are configured correctly and they return OK. `ServerError` can be disregarded.
 11. Open your PR
 
 Do not increment version numbers but update `CHANGELOG.md`

MANIFEST.in

@@ -20,17 +20,18 @@ Brawl Stats
     :target: https://github.com/SharpBit/brawlstats/blob/master/LICENSE
     :alt: MIT License
 
-- This library is a sync and async wrapper for https://api.starlist.pro (BrawlAPI) and the official Brawl Stars API.
+- This library is a sync and async wrapper for the Brawl Stars API.
 - Python 3.5.3 or later is required.
 
 Features
 ~~~~~~~~
 
-- Covers all of the endpoints of both APIs.
-- Use the same client for sync and async usage.
-- Choose which API you want to use!
-- Access game constants such as maps, brawlers, and images.
 - Easy to use with an object oriented design.
+- Use the same client for sync and async usage.
+- Get a player profile and battlelog.
+- Get a club and its members.
+- Get the top 200 rankings for players, clubs, or a specific brawler.
+- Get information about maps, brawlers, and more!
 
 Installation
 ~~~~~~~~~~~~
@@ -45,7 +46,7 @@ Install the development build:
 
 ::
 
-   pip install git+https://github.com/SharpBit/brawlstats
+   pip install git+https://github.com/SharpBit/brawlstats@development
 
 Documentation
 ~~~~~~~~~~~~~
@@ -54,7 +55,7 @@ Documentation is being hosted on `Read the Docs`_.
 
 Examples
 ~~~~~~~~
-Examples are in the `examples folder`_. Within each folder, you will find:
+Examples are in the `examples folder`_.
 
 - ``sync.py`` shows you basic sync usage
 - ``async.py`` shows you basic async usage
@@ -64,9 +65,8 @@ Misc
 ~~~~
 
 - If you are currently using this wrapper, please star this repository :)
-- If you come across an issue in the wrapper, please `create an issue`_. Do **not** PM me on Discord for help.
-- If you need an API Key for BrawlAPI, create one using the `dashboard`_. If you need one for the official API, visit https://developer.brawlstars.com
-- To receive help for using the BrawlAPI, I recommend you join BrawlAPI's `discord server`_.
+- If you come across an issue in the wrapper, please `create an issue`_.
+- If you need an API key, visit https://developer.brawlstars.com
 
 Contributing
 ~~~~~~~~~~~~
@@ -83,12 +83,10 @@ Special thanks to this project's contributors ❤️
 If you want to contribute, whether it be a bug fix or new feature, make sure to follow the `contributing guidelines`_.
 
 .. _create an issue: https://github.com/SharpBit/brawlstats/issues
-.. _discord server: https://discord.gg/vbbHXNf
 .. _Read the Docs: https://brawlstats.rtfd.io/
 .. _examples folder: https://github.com/SharpBit/brawlstats/tree/master/examples
 .. _discord.py: https://github.com/rapptz/discord.py
 .. _contributing guidelines: https://github.com/SharpBit/brawlstats/blob/master/CONTRIBUTING.md
-.. _dashboard: https://api.starlist.pro/dashboard
 
 .. _4JR: https://github.com/fourjr
 .. _OrangutanGaming: https://github.com/OrangutanGaming

README.rst

@@ -1,5 +1,5 @@
-from .brawlapi import Client as BrawlAPI
-from .officialapi import Client as OfficialAPI
+from .core import Client
+from .models import *
 from .errors import *
 
 
@@ -8,7 +8,7 @@
 ############
 
 
-__version__ = 'v3.0.4'
+__version__ = 'v4.0.0'
 __title__ = 'brawlstats'
 __license__ = 'MIT'
 __author__ = 'SharpBit'