Metadata-Version: 2.3
Name: ezoff
Version: 1.22
Summary: Python package for interacting with EZOffice API
Author: Jordan Maynor
Author-email: Jordan Maynor <jmaynor@pepsimidamerica.com>
License: This is free and unencumbered software released into the public domain.
         
         Anyone is free to copy, modify, publish, use, compile, sell, or
         distribute this software, either in source code form or as a compiled
         binary, for any purpose, commercial or non-commercial, and by any
         means.
         
         In jurisdictions that recognize copyright laws, the author or authors
         of this software dedicate any and all copyright interest in the
         software to the public domain. We make this dedication for the benefit
         of the public at large and to the detriment of our heirs and
         successors. We intend this dedication to be an overt act of
         relinquishment in perpetuity of all present and future rights to this
         software under copyright law.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
         EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
         MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
         IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
         OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
         ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
         OTHER DEALINGS IN THE SOFTWARE.
         
         For more information, please refer to <https://unlicense.org>
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
Classifier: Operating System :: OS Independent
Requires-Dist: pydantic>=2.11.9
Requires-Dist: requests>=2.32.5
Requires-Dist: tenacity>=9.1.2
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/pepsimidamerica/ezoff
Description-Content-Type: text/markdown

# ezoff

Python package for interacting with the EZOffice API. Largely uses v2 API endpoints, a couple v1 are used in cases where there aren't any documented v2 versions. Additionally, a few of the JSON API endpoints (found using the browser console) are supported.

- [v1 API Documentation](https://ezo.io/ezofficeinventory/developers/)
- [v2 API Documentation](https://www.ezofficeinventory.com/api-docs/index.html)

## Installation

`pip install ezoff`

## Usage

Two environment variables are required for ezoff to function.

| Env Variable | Description |
| --------- | ----------- |
| EZO_SUBDOMAIN | Should be your company name. Can be found in the URL of your EZO instance, https://{companyname}.ezofficeinventory.com/ |
| EZO_TOKEN | The access token used to authenticate requests |

`python-dotenv` package is useful for loading variables from an `.env` file. Otherwise, can be done directly with `os`.

## Project Structure

Project is split up into several files depending on what area of the EZOffice API is being dealt with. largely corresponds to how the API v2 documentation is laid out, purely for organizational purposes.

## Notes

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