Django-cassiopeia

- Fix breaking of match v5

News

Starting version 2.1, django-cassiopeia will no longer contain cassiopeia in its modules, instead it will wrap you original cassiopeia framework with the necessary changes in place. This makes easy to get ahead of fixes of the main library without the need of me doing pararel updates, when cassiopeia updates a new version, you can get going by only upgrading cassiopeia with `pip install cassiopeia --upgrade`.

This package has finished its testing during v1.x.

New features.

1. In response to issue 1 , a new datastore called `Omnistone` is introduced, it is a refined version of cassiopeia `Cache` that will protect you from memory issues and speeding up performance.

2. A brand new documentation is added, no longer uses read the docs, this time is on github page and using VuePress for better styling.

Backward Incompatible Changes

1. `RIOT_API_KEY` is now `CASSIOPEIA_RIOT_API_KEY`. This is due to a possible variable name conflict, since you might have different API keys for different games (yes I am looking at you Valorant).

2. `CASSIOPEIA_GLOBAL` has splitted into `CASSIOPEIA_VERSION_FROM_MATCH` and `CASSIOPEIA_DEFAULT_REGION` because the settings is global but wasn't global visually.

3. `CASSIOPEIA_DJANGO_CACHES` is merged back to `CASSIOPEIA_PIPELINE`, because .. it's starting to be hard to maintain. When `Omnistone` was created, an issue came up that it's limiting the flexibility of the pipeline, and makes confusions. Now you specify everything inside `CASSIOPEIA_PIPELINE` since expirations is now shorten (a lot), so it won't be large neither. Check out the example at the end of [Setup Pipeline](./pipeline.html).

Other Changes

1. Now arguments keys can be all uppercase to fit into the Django settings syntax (e.g. instead of `"expirations_map"` now can be `"EXPIRATIONS_MAP"`).

* Shorten the Django settings for handling Riot API request errors (in a 1:3 ratio), check out the documentation for its new syntax (Ctrl F5 to clean reload in case your brower loads the cached page).
* Moved out the entire setting mapping logic to a separate file for better maintainance, mainly `_cassiopeia.settings.py -> django_cassiopeia.utils.py`.

First Release of Django Cassiopeia

An Integration of [Cassiopeia](https://github.com/meraki-analytics/cassiopeia) to the Django Framework (Compatible with DRF) including more new features.

Cassiopeia itself is a Python adaptation of the Riot Games League of Legends API (https://developer.riotgames.com/). For instance it is also the sister library to [Orianna](https://github.com/robrua/Orianna) (Java). It's been designed with usability in mind - making sure all the bookkeeping is done right so you can focus on getting the data you need and building your application.

Documentation
Django Cassiopeia has detailed [documentation](https://django-cassiopeia.readthedocs.io/en/latest/).
For functions and methods of Cassiopeia is found is this [documentation](http://cassiopeia.readthedocs.org/en/latest/)

Installation and Requirements
python
Django>=3.0.1
Python>=3.6

pip install django-cassiopeia


Quick Start and/or Setup for your Django Project

* Please check out the things that you should NOT do when using django-cassiopeia in this [page](https://django-cassiopeia.readthedocs.io/en/latest/cautions/)
* For setup in your Django environment, follow the setup instructions in django-cassiopeia's [documentation](https://django-cassiopeia.readthedocs.io/en/latest/django-setup/)
* A Quick Start is also provided on django-cassiopeia's [documentation](https://django-cassiopeia.readthedocs.io/en/latest/examples/)
* Taking in mind the instruction above, for all the methods and function of cassiopeia is found in this [documentation](http://cassiopeia.readthedocs.org/en/latest/)