API for Urban Rivals collection management
Project description
A module to support reading player purchase history data and storing it in a database.
- Puchases History Use:
Import api from urcollectionmanager
Create a request.Session and pass it, along with your credentials to session_connect_to_ur
Pass that same session (now authenticated) to get_purchase_history along with the number of pages to scrape.
Pass the result to convert_purchase_history
Optionally: Pass result to your own HTML parser.
You now have a list of Purchase objects that contain all relevant information available from the purchase history page.
- Missions Use:
Import api from urcollectionmanager
Create a request.Session and pass it, along with your credentials to session_connect_to_ur
Pass that same session (now authenticated) to get_missions_list along with the mission category to find. An empty string returns everything.
Pass the result to convert_missions
Optionally: Pass result to your own HTML parser.
You now have a list of Mission objects that contain all relevent information available from the missions page.
- Database Use:
Run connect_and_initialize_database if you have a particular database location you want to connect to. By default this will connect to data/collection.sqlite
Pass a list of Purchase objects to write_history_to_database
If using convert_purchase_history, you will need to flatten the list of lists
Once the database has Purchase objects in it, you can run get_history_from_database to retrieve them.
Similarly, you can run write_missions_to_database to write Mission objects and get_missions_from_database to read mission Mission objects from the same database as Purchases.
Dev
- How To Use Tools:
- Poetry
To run the project (preferably configure venv first)
>>> poetry install
To configure your venv
>>> python -m venv /path/to/new/virtual/environment >>> poetry env info
If env info does not match your path, try manually running Scripts/activate inside that environment
To add a dependency (add a -D if it’s only for development)
>>> poetry add <dependency>
- Commitizen
>>> git add >>> cz c
More options can be found under options under Commitizen
- PreCommit
Update .pre-commit-config.yaml, then run
>>> pre-commit install >>> pre-commit run --all-files
More hook plugins can be found at PreCommitHooks
TODO:
Use UR-API to collect player data. UR-API-Example
Default to file output (excel or some form of that)
Testing (pytest, Coverage-py)
Documentation (Sphinx)
Not Required at this Time:
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for urcollectionmanager-1.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7843c20876db840dff201a8a115ff0668357ffff057b13b9ba9534fc51c03e46 |
|
MD5 | 9a130c0b4fe555ef3d7f720245c3fe5c |
|
BLAKE2b-256 | 410025868106bb6abb664ebc6421eb575772208d504f9c946492fdc03e5cc95a |
Hashes for urcollectionmanager-1.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 578bcb75122b52f9fa27f1854a9665c16eed02534a213da5eecedab7b244f73e |
|
MD5 | 19f49d74cba12e7eb2a12a628311124b |
|
BLAKE2b-256 | ad1e7e35801bacfc36ae87bfae8298d222fe46956e12a4dfb74b8cbafd669b05 |