Illumio

--------------------------

.. rubric:: NEW FEATURES

* add `PolicyComputeEngine.set_tls_settings` function to update verify and cert values for PCE requests session
* add `PolicyComputeEngine.must_connect` function to complement `check_connection`, raising the exception on failure rather than suppressing it

.. rubric:: BUG FIXES

* fix issue where PCE request could throw NoneType exception if incorrectly configured

--------------------------

.. rubric:: BUG FIXES

* fix check_connection call to avoid 404s on some PCEs

.. rubric:: NEW FEATURES

* add default timeout to `PolicyComputeEngine` requests session
* add `PolicyComputeEngine.set_timeout` function to update timeout
* add `_PCEAPIObject.get_by_name` function as a convenience method for finding an exact name match

--------------------------

.. rubric:: BUG FIXES

* fix check_connection call to work with SaaS PCEs

--------------------------

.. rubric:: NEW FEATURES

* readthedocs documentation generated with Sphinx
* API documentation
* install guide
* user guide
* common use-cases
* advanced usage
* add `illumio.events` module
* adds `/events` PCE API endpoint
* add `PolicyComputeEngine.get_default_service` function
* added constant values to `illumio.util.constants`
* `ALL_SERVICES_NAME` - default `All Services` Service object name
* `RESOLVE_AS_WORKLOADS` - rule label resolution as workloads
* `RESOLVE_AS_VIRTUAL_SERVICES` - rule label resolution as virtual services
* `ICMP_CODE_MAX` - ICMP Code max value
* `ICMP_TYPE_MAX` - ICMP Type max value
* add enumerations to `illumio.util.constants`
* `ApplyTo` - enum in place of Virtual Service module constants
* `VENType` - enum for `VEN.ven_type` field
* `ChangeType` - enum for `ResourceEvent.change_type` field
* `EventSeverity` - enum for `BaseEvent.severity` field
* `EventStatus` - enum for `BaseEvent.status` field

* add `illumio.util.jsonutils.Error` dataclass to capture API error responses

.. rubric:: IMPROVEMENTS

* update `illumio.rules.Rule.build` function to use `['workloads']` as consumer/provider label resolution default
* broad improvements to pydoc
* add `__all__` to all modules
* bug fixes and type hint improvements

--------------------------

.. rubric:: BUG FIXES

* add `FirewallCoexistence` object to fix decoded `Workload.firewall_coexistence` data type

--------------------------

.. rubric:: DEPRECATIONS

* `PolicyComputeEngine.base_url` is DEPRECATED and will be removed in version 2.0.0. The URL is built on each request instead for more flexibility

.. rubric:: NEW FEATURES

* add `PORT_MAX` constant to `illumio.util.constants`
* add `IllumioIntegerValidationException` class
* add int validation helper function

.. rubric:: IMPROVEMENTS

* validate `PolicyComputeEngine` org_id and port values on init
* build URL for each request `PolicyComputeEngine`
* add private member vars for scheme/hostname/port/version
* update `PolicyComputeEngine.check_connection` to make a second call to validate org_id