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:
Metadata
Release files for urcollectionmanager 1.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| urcollectionmanager-1.1.3.tar.gz | 10.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| urcollectionmanager-1.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.4 kB
Release files / urcollectionmanager-1.1.3.tar.gz
| Download URL | urcollectionmanager-1.1.3.tar.gz |
|---|---|
| Size | 10.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
28960a3adf507a38cdb481331c61f58f2d3c12dbb7473cfca791cb1bf17bdb7f
|
|
BLAKE2b-256 checksum How to use checksums |
75d2610300f91be19973d408e40cf7cbe223be9596ca369e7e9a422bf5018577
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.5 CPython/3.8.1 Windows/10
|
Release files / urcollectionmanager-1.1.3-py3-none-any.whl
| Download URL | urcollectionmanager-1.1.3-py3-none-any.whl |
|---|---|
| Size | 11.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a17045af990f726ae80613f970be2a99c9c4be6507caa7339ab4cc3c3c399ace
|
|
BLAKE2b-256 checksum How to use checksums |
6e89444b0d3bf9bb47c26cc5e5bfa174d9399a9a7f203b8b9fad61ca8cd7ef14
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.5 CPython/3.8.1 Windows/10
|
Security for urcollectionmanager 1.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.