Skip to main content

Python package that acts as a wrapper for the EZOffice API.

Project description

ezo

Python package for interacting with the EZOffice API

Installation

Add as a git submodule for now. Intend on at some point making available as a proper package.

Usage

Several environment variables are required for ezo to function.

Required? Env Variable Description
EZO_BASE_URL Yes Should be https://{companyname}.ezofficeinventory.com/
EZO_TOKEN Yes The access token used to authenticate requests

Project Structure

Project is split up into several files depending on what area of the EZOffice API is being dealt with. Purely for organizational purposes.

Assets

Groups

Locations

Members

Work Orders

Notes

The documentation is mistaken on custom fields (insofar as filling them out when creating an object or updating the custom field on an already existing object). It says to put underscores in place of spaces in the field name, but this is incorrect. After testing the API, it appears it wants the actual name of the field with the spaces, not underscores. At least on members.

Similarly, the documentation isn't exhaustive when it comes to listing the valid fields when creating or updating something. Frequently there are fields on the actual page that aren't mentioned in the EZOffice documentation. Throughout program I check for that keys provided are valid to prevent the API call from erroring out. Just have to add to list of valid key whenever we run into one.

When wanting to clear a field out of its current value with an update function, generally the empty string ("") should be used.

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

ezoff-0.1.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

ezoff-0.1.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file ezoff-0.1.0.tar.gz.

File metadata

  • Download URL: ezoff-0.1.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for ezoff-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3f672834050067295c95c623ff3addb082cc7a578442516dcaf27a546a89fd07
MD5 304e1ce408806d1e234dfc06bc6efef9
BLAKE2b-256 fe52ae147c4ca7b0f70fc8df32485f679e0993d2057076d55f9c10fd0c077c3c

See more details on using hashes here.

File details

Details for the file ezoff-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ezoff-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for ezoff-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5027d6c4bb8d0bddf385865df0ef2959062356ac4629c77785df21d95565ba2
MD5 af7e41cfd5d330722677a440f31649a1
BLAKE2b-256 5ea163c45a9b98034daf298e766e302fe92473b1de6dd48f4f95ca7428438da0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page