This release is a pre-release and may not be stable for production use.
fawrapper
A python wrapper for the FieldAware API.
requires a FIELDAWARE_TOKEN environment variable
Installation
Fawrapper is currently supported on python 3.6
pip install git+https://github.com/j-kirch/fawrapper
Quickstart
Assuming you already have at token provided by Fieldaware, you can create an intance of the FieldawareAPIClient like so:
from fawrapper import FieldawareAPIClient
# If you have set the environment variable ``FIELDAWARE_TOKEN``
api = FieldawareAPIClient()
# Or you can include the token
api = FieldawareAPIClient(api_key="your_token")
With the api instance you can interact with Fieldaware:
# List all users
users_list = api.users.list()
for user in users_list:
print('First Name: ', user.first_name, 'UUID: ', user.uuid)
# List all jobs
jobs_list = api.jobs.list()
for job in jobs_list:
print('Job Number: ', job.id, 'UUID: ', job.uuid)
# Get a user with uuid
user = api.users.get('user_uuid')
# Get a job with uuid
job = api.jobs.get('job_uuid')
# With the Job and a User instance, you can update the api by setting the
# attribute to the user
job.job_lead = user
Documentation
TODO
Contribution
If you find an API method that is not supported yet, feel free to create a Github issue.
You are more than welcome to submit a pull request for bug fixes or additional features.
Thank you!
License
Metadata
Release files for fawrapper 0.1.0a6
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 | Actions |
|---|---|---|---|---|
| fawrapper-0.1.0a6.tar.gz | 12.7 kB | Without provenance | Details for fawrapper-0.1.0a6.tar.gz |
Release files / fawrapper-0.1.0a6.tar.gz
| Download URL | fawrapper-0.1.0a6.tar.gz |
|---|---|
| Size | 12.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
65793547fd4d8de0b69c0cf8ba5be54d9541a15b98d7bc633bbc9e55fb612435
|
|
BLAKE2b-256 checksum How to use checksums |
81ab2c4945a3301b512b04add8e0678df042b26fc65cd76f68d337b15adcefbc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for fawrapper 0.1.0a6
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.