API for Urban Rivals collection management
Project description
A module to support reading player purchase history data and storing it in a database.
- Basic 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.
- 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.
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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91e10e7e25ca210fa0ceca08d38473fb3209cbf40174ef8d3f20aeaac8d59e9f |
|
MD5 | 47d03b28e80f7271a2ab04fcf0d33f3a |
|
BLAKE2b-256 | e59be29763e65e62d1c55fe1985fd0ec88cb29dc2c4b015a70a58cf51356fc7c |
Hashes for urcollectionmanager-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20cac812327f33823e106b929feab37a0ce151c87da108eceee6675055a41c1f |
|
MD5 | e0d287702c2244812fd896b8295eb45c |
|
BLAKE2b-256 | 36bee1e301d9eafb38acd69a2a513ea81685122c1215532f93fabfd3b6e4b131 |