The rosteron module allows read-only access to rostering information in instances of RosterOn Mobile, a workforce management product from Allocate Software.
>>> import rosteron
>>> with rosteron.Session('https://rosteron.xyz.com.au/RosterOnProd/Mobile') as session:
... session.log_in('joe.bloggs', 'abc123')
... snapshot = session.get_roster()
>>> print(snapshot)
<Snapshot (time=2019-06-10T08:03:12+00:00, len=19)>
>>> for item in snapshot[:3]:
... print(item)
<Item (date=2019-06-11, title='ABCDE - Melbourne Office', detail=('10:30 - 18:06', None, 'XYZ', 'Assistant'))>
<Item (date=2019-06-12, title='ABCDE - Melbourne Office', detail=('10:30 - 18:06', None, 'XYZ', 'Assistant'))>
<Item (date=2019-06-13, title='ABCDE - Melbourne Office', detail=('10:30 - 18:06', None, 'XYZ', 'Assistant'))>
Features
Roster data includes server-side retrieval timestamps.
Sessions automatically log out after use (when used in a with block).
Meaningful Python exceptions are raised when problems arise.
Requests & responses to/from RosterOn can optionally be logged to files for debugging.
Installation
Install this module from PyPI using pip:
pip install rosteron
Support
Bug reports, feature requests, and questions are welcome via the issue tracker.
- Issue tracker:
Contribute
Sample responses from other RosterOn installations
Roster output is minimally structured on the assumption that each RosterOn instance formats its data differently (the author has only seen data from one RosterOn Mobile instance).
Roster response samples from other RosterOn Mobile instances would be very gratefully received, as these may demonstrate uniformity across all instances, which would allow future releases of this module to provide more structured output.
Source code
Pull requests are gratefully received and considered.
- GitHub repository:
License
This project is licensed under the MIT License.
1 maintainer
Release files for rosteron 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rosteron-1.0.0.tar.gz | 13.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rosteron-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.0 kB
Release files / rosteron-1.0.0.tar.gz
| Download URL | rosteron-1.0.0.tar.gz |
|---|---|
| Size | 13.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f0d3f3df9e33dbf2226eec3b033e72899a43c2b8f241a76b4795b3cdf2ce61ab
|
|
BLAKE2b-256 checksum How to use checksums |
f173f8ca5e22d13c5b4f66e7751bf4688dfe207acae12f824c791080f98cd4c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
|
Release files / rosteron-1.0.0-py3-none-any.whl
| Download URL | rosteron-1.0.0-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b76bcbd34ce5c95ac2dc5873fd7ca4312d08dd9ce27c07db962633a0fdeff0d3
|
|
BLAKE2b-256 checksum How to use checksums |
7b83bcf48e935770348fae50f66808dc01975a2e5666f53b53188ed2460997dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
|
