Pyclarify

Fixed

- Integration parameter in `SignalSelectView` is now optional, as it would break on some occations.
- More descriptive warning message when using `None` or `[None]` in `query.Filters`.

Added

- All select queries (`client.select_items`, `client.select_signals`) now supports a `None` limit to do an exhaustive query for all resources.
- Sanity checks for initializing `pyclarify.Client` with more descriptive errors.

Changing to JSON:API format!

Added

- `fields` folder containing all fields used internally.
- `views` folder containing all models for communicating with the API.
- `jsonrpc` folder containing all network functionality for the `ClarifyClient`.
- `pyclarify.query.filter.DataFilter` for filtering on DataFrames.
- `pyclarify.client.Client.data_frame()` for selecting DataFrames.

Changed

- `pyclarify.client.ClarifyClient` renamed to `pyclarify.client.Client`
- Moved `ResourceQuery` and `DataQuery` models to `pyclarify.query.query`.
- Moved `Comparison` and `Operators` to `pyclarify.fields.query`.
- Moved `DataFrame` and all sub methods to `pyclarify.views.dataframe`.
- `merge`, `to_pandas` and `from_pandas` methods are now class methods on the `pyclarify.views.DataFrame` class.

python
from pyclarify import DataFrame

series = {"signal_1" : [1, 2]}
times = ["2021-11-01T21:50:06Z", "2021-11-02T21:50:06Z"]
df = DataFrame(series=series, times=times)

panda_df = df.to_pandas()

new_df = DataFrame.from_pandas(panda_df)

merged = DataFrame.merge([df, new_df])


- `pyclarify.client.Client.select_items()` now responds with `JSON:API` format, and does not retrieve data frames.

python
client.select_items(
filter = query.Filter(fields={"name": query.NotEqual(value="Air Temperature")}),
skip = 0,
limit = 10,
sort = ["-id", "name"],
total=True
)


- `pyclarify.client.Client.select_signals()` replaced `pyclarify.client.ClarifyClient.select_signals_filter()`.
- `pyclarify.client.Client.select_signals()` now responds with `JSON:API` format.

python
client.select_signals(
filter = Filter(fields={"name": filter.NotEqual(value="Air Temperature")}),
limit = 10,
skip = 0,
sort = ["-id"],
total= True,
include = ["item"]
)


- `GetToken` method renamed to `Authenticator`.
- `pyclarify.jsonrpc.pagination.ItemIterator` renamed to `SelectIterator` and now paginates `select_signals`, `select_items` and `data_frame` methods.
- Fix bug where timestamps was not timezone aware.
- Fix bug where pagination was not applied correctly.

Removed

- `pyclarify.client.APIClient`
- `pyclarify.client.Client.get_token()`
- `pyclarify.client.Client.select_items_metadata()`
- `pyclarify.client.Client.select_items_data()`
- `pyclarify.client.Client.select_signals_filter()`

Fixed

- Adding `insert` method to `pyclarify.client.ClarifyClient`

Added

- `pyclarify.client.ClarifyClient.select_items()` using `query.Filter` model.
- `pyclarify.client.ClarifyClient.select_signals_filter()` using `query.Filter` model. NB! Will be renamed `pyclarify.client.ClarifyClient.select_signals()` in the future and replace current `select_signals()` method.
- Deprication warning module in `pyclarify.__utils__.warnings`

Changed

- Replaced custom time parse methods with `pydantic.datetime_parse` methods.
- ContentHash is constrained as plain string and not SHA1.

Deprecated

- `pyclarify.client.ClarifyClient.select_items_metadata()`
- `pyclarify.client.ClarifyClient.select_items_data()`
- `pyclarify.client.ClarifyClient.select_signals()`
- `pyclarify.client.APIClient`

Changed

- Renamed file `convert.py` to `time.py`.
- Refactored `pagination.GetDates` and changed name to `pagination.TimeIterator`.
- Refactored `pagination.GetItems` and changed name to `pagination.ItemIterator`.
- Minor changes to names in `time.py` to be more precise.
- Refactored `iterator` wrapper to use said iterators.
- `pyclarify.client.make_request()` now uses iterator and is only method for sending requests.
- Extended `models.response.Response` to handle add operation.
- Refactored return on all methods in `client.ClarifyClient` and `client.APIClient`.

Removed

- `pyclarify.__utils__.convert.str_to_datetime()`
- `pyclarify.client.pretty_response()`
- `pyclarify.client.iterate_bool()`
- `pyclarify.client.send_simple()`
- `pyclarify.client.send_iter()`

Added

- RFC3339 to time delta function in time.py.
- `__add__()` functionality to SelectItemsResponse model and GenericResponse model.
- Filter model to create filters and combining them.
Filter is based on MongoDB filters and works as described in [the docs](https://docs.clarify.io/api/1.1beta1/methods/filter-syntax).

Usage:

python
from pyclarify import filter

f1 = filter.Filter(fields={"name": filter.NotEqual(value="Lufttemperatur")})
f2 = filter.Filter(fields={"labels.unit-type": filter.NotIn(value=["Flåte", "Merde 5"])})

f1.to_query()
>>> {'name': {'$ne': 'Lufttemperatur'}}

f3 = f1 & f2
f3.to_query()
>>> {
>>> '$and': [
>>> {'name': {'$ne': 'Lufttemperatur'}},
>>> {'labels.unit-type': {'$nin': ['Flåte', 'Merde 5']}}
>>> ]
>>>}


Complete list of operators:

- Equal
- NotEqual
- Regex
- In
- NotIn
- LessThan
- GreaterThan
- GreaterThanOrEqual

- Exception class for `FilterError` and `TypeError` both located in `__utils__.exceptions`.

Fixed

- Validator on `models.data.DataFrame` now converts `numpy.nan` to native python `none` .
- `annotations` field on `models.data.SignalInfo` is now optional.