https://github.com/uptick/pyworkflowmax
A Python API around WorkflowMax's REST API
https://github.com/uptick/pyworkflowmax
Last synced: 11 months ago
JSON representation
A Python API around WorkflowMax's REST API
- Host: GitHub
- URL: https://github.com/uptick/pyworkflowmax
- Owner: uptick
- License: bsd-3-clause
- Created: 2016-08-17T04:47:28.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-12-18T12:22:12.000Z (over 9 years ago)
- Last Synced: 2024-11-10T12:47:43.446Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 12.7 KB
- Stars: 6
- Watchers: 5
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyWorkflowMax
PyWorkflowMax is a Python API for accessing the REST API provided by the [WorkflowMax](https://www.workflowmax.com/api/)
job management tool.
## Getting started
Install:
```
pip install pyworkflowmax
```
Create a `Credentials` instance and provide your API and account keys:
```
from workflowmax import Credentials
cred = Credentials(
api_key=os.environ.get('WORKFLOWMAX_API_KEY'),
account_key=os.environ.get('WORKFLOWMAX_ACCOUNT_KEY')
)
```
Create a `WorkflowMax` instance, supplying the credentials:
```
from workflowmax import WorkflowMax
wfm = WorkflowMax(cred)
```
Access stuff:
```
important_clients = wfm.clients.search(query='VIP')
```
If you don't know what you're looking for:
- the repr of a `WorkFlowMax` instance will yield a list of available managers (i.e. `clients` in the above example).
- the repr of a `Manager` instance will yield a list of available methods on that manager. Each method corresponds to an API call in WorkFlowMax.
## Development
This project is still a baby. It has no tests, limited post/patch functionality, and supports Python 3 only.
Contributions are welcome. ;)