kognic-io

Name	kognic-io JSON
Version	2.1.2 JSON
	download
home_page
Summary	Kognic IO Client
upload_time	2024-02-27 15:54:43
maintainer
docs_url	None
author
requires_python	>=3.7
license	MIT
keywords	kognic api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

# Kognic IO Client

Python 3 library providing access to Kognic IO

To install with pip run `pip install kognic-io`

# Documentation & Getting Started Guide

Documentation about how to use the library can be found [here](https://developers.kognic.com/)

# Changelog

All notable changes to this project will be documented in this file.

## [2.1.2] - 2024-02-27

- Bump dependency on `kognic-base-clients` to `2.3.4`

## [2.1.1] - 2024-02-21

- add `max_connection` parameter in resource clients to allow for more control over the number of network connections

## [2.1.0] - 2024-01-30

- add API client to order-execution-api, including kognic-io client parameter to override order_execution_api_host

## [2.0.1] - 2023-11-22

- Default values on `Optional` fields to handle pydantic v2.0.0
- Adds scene_external_id to the pydantic input model

## [2.0.0] - 2023-11-17

- Bumped pydantic to v2. No breaking changes in the kognic-io interface, but if you are using pydantic directly you may need to update your code.

## [1.8.0] - 2023-10-31

### Added

- Utilities for custom camera calibrations
- `kognic.io.tools.calibration.validation` for validating custom camera calibrations
- `kognic.io.tools.calibration.compilation` for compiling custom camera calibrations to WebAssembly

## [1.7.0] - 2023-10-18

### Added

- Method to query request inputs, use it with `client.input.query_inputs(...)`
- `create_from_scene(...)` now returns created inputs
- New `Input` model representing a scene in a request
- Modelling for `CustomCameraCalibration` using WebAssembly

### Deprecated

- The method `get_inputs_with_uuids` (use `get_scenes_by_uuids` instead)
- The method `get_inputs` (use `query_inputs` instead)
- The old `kognic.io.model.input.input_entry.Input` model along with `kognic.io.model.input.input_entry.InputStatus`

## [1.6.0] - 2023-10-06

### Added

- Method to get scenes by uuids, use it with `client.scene.get_scenes_by_uuids([...])`
- Method to get an annotation by input uuid `client.annotation.get_annotation_for_input(input_uuid)`
- Method to get all annotations for a scene `client.annotation.get_annotations_for_scene(scene_uuid)`
- Method to invalidate scenes `client.scene.invalidate_scenes([scene_uuid, ...], reason)`
- Method to delete an input `client.input.delete_input(input_uuid)`

### Changed

- Renamed `input_type` field on `Input` to `scene_type`
- Renamed `input_uuid` to `scene_uuid` on the following methods
- `client.annotation.get_annotation`
- `client.input.invalidate_inputs`
- `client.input.add_annotation_type`
- `client.input.remove_annotation_types`
- `client.input.get_inputs_by_uuids`
- Renamed `input_uuid` parameter in `get_annotation` to `scene_uuid`

### Deprecated

- The method `invalidate_inputs` (use `invalidate_scenes` instead)
- The method `remove_annotation_types` (use `delete_input` instead)
- `input_type` on the `Input` model (use `scene_type` instead)
- `input_uuid` parameter in favour of `scene_uuid` on the following methods
- `client.annotation.get_annotation`
- `client.input.invalidate_inputs`
- `client.input.add_annotation_type`
- `client.input.remove_annotation_types`
- `client.input.get_inputs_by_uuids`

## [1.5.0] - 2023-09-29

### Added

- Support for asynchronous callbacks in `FileData`

## [1.4.0] - 2023-09-22

### Added

- Added missing `FileData.Format.WEBP` to enable use of WebP for `FileData` images (which were already supported for `InputModel.Image`)
- Support for new camera model named custom.

### Changed

- Renamed `lidar_and_cameras` attribute to `lidars_and_cameras` on `KognicIOClient`
- Renamed `uuid` field on `Input` to `scene_uuid`
- Renamed `input_uuid` field on `Annotation` to `scene_uuid`
- Renamed response from `create` method from `CreateInputResponse` to `CreateSceneResponse`. Also renamed `input_uuid` field to `scene_uuid` in the response.
- Renamed `InvalidatedReasonInput` to `InvalidatedReasonScene`
- Moved all scene models (for example `LidarsAndCameras`) from `kognic.io.model.input` to `kognic.io.model.scene`

### Deprecated (will be removed in a future release)

- `lidar_and_cameras` attribute on `KognicIOClient`
- `uuid` field on `Input`
- `input_uuid` field on `Annotation`
- `CreateInputResponse` response from `create` method along with its `input_uuid` field
- `InvalidatedReasonInput`
- Scene models in `kognic.io.model.input`

## [1.3.0] - 2023-08-08

### Changed

- Validate that all required local image and pointcloud files exist before beginning to create scenes.
- Validation errors will be raised for missing or empty files.
- `Image` and `PointCloud` `filename` must refer to a file that exists & contain data unless a callback or raw bytes are provided.
(i.e. there is no validation any time `FileData` are used)
- Support for new camera model named Principal Point Fisheye model.

## [1.2.2] - 2023-07-05

### Changed

- Pin pydantic version to <2
- Remove dependency on `Pillow`

## [1.2.1] - 2023-05-19

### Added

- Add optional attribute max_altitude_angle to fused cylindrical camera model

## [1.2.0] - 2023-05-09

### Added

- Support for new camera model named Cylindrical model.

### Bugfix

- Fixed bug where the calibration types were not used coherently across different calibration models. This resulted in check such as `if calibration.calibration_type == CalibrationType.PINHOLE` to fail in some cases.

## [1.1.9] - 2023-04-12

### Added

- Wrapper function `create_inputs` that allows creation of multiple inputs (with or without a pre-annotation) with a single call. This is useful since it contains wait-logic for the scene to be ready before creating inputs.

## [1.1.8] - 2023-03-17

### Added

- Support for custom lens projection coefficients for Principal Point Distortion model.

## [1.1.6] - 2023-03-14

### Added

- Support for new camera model named Fused Cylindrical model.

### Changed

- Fixed bug where files intended to be uploaded using data from a callback or in-memory blob would sometimes be incorrectly handled if their callback or blob could be coerced to `False`.

## [1.1.5] - 2023-01-20

### Added

- Support for the new input type `aggregated_lidars_and_cameras_sequence`. This new input type is a sequence of cameras
and point clouds, but the point clouds are aggregated over time. More information can be found [here](https://developers.kognic.com/docs/kognic-io/inputs/aggregated_lidars_and_cameras_seq).
- New parameter `include_content` in `get_project_annotations` that lets you choose whether to fetch the annotation content
or not

## [1.1.4] - 2022-12-02

### Changed

- Bumped dependency on `kognic-base-clients` to `1.0.3` which introduces retry when uploads fail for TCP or SSL timeout reasons.

## [1.1.2] - 2022-11-25

### Changed

- Fixed issue with parsing of custom metadata fields

## [1.1.1] - 2022-11-11

### Added

- The raw bytes for each scene resource (`Image`, `PointCloud`) may now be provided in different ways:
- read from a local file, as before (no changes are needed to continue using this behaviour)
- passed directly when creating the resource
- loaded progressively during the upload via a callback

Refer to [the updated documentation](https://developers.kognic.com/docs/kognic-io/overview#image--pointcloud-resources)
for details about how to use the new API features.

### Changed

- `metadata` is once again an optional attribute on model classes that use it (`CamerasSequence` among others)

## [1.0.2] - 2022-11-01

### Changed
- Bumped dependency on `kognic-base-clients` to `1.0.1`
- Added pagination to the `get_inputs` method to prevent timeouts

### Bugfix
- Metadata should default to an empty dict

## [1.0.1] - 2022-10-18

- Updated readme

## [1.0.0] - 2022-10-18

This is a major release with breaking changes and refactorings.
Please refer to our Annotell-2-Kognic [migration guide](https://developers.kognic.com/docs/a2k_migration_guide)
for details.

### Changed
- Annotell becomes Kognic
- Bumped minimum python version from 3.6 to 3.7
- Packaging changes
- Remaining `@dataclass`es in our model packages are now pydantic models with better validation

### Removed
- Deprecated calibration models
- Deprecated `get_annotations` method

---

# Changelog (before rebranding)

## [1.3.1] - 2022-09-13

### Bugfix
- Changed naming in PrincipalPointDistortionCalibration

## [1.3.0] - 2022-09-09

### Changed
- Added PrincipalPointDistortionCalibration

## [1.2.6] - 2022-08-19

### Bugfix

- Fixed error when using deprecated calibration model `annotell.input_api.model.calibration.sensors.LidarCalibration`
- We encourage updating to use the newer, typed calibration models in `annotell.input_api.model.calibration.{camera, lidar}.*`,
[refer to the calibration documentation for details](https://developers.kognic.com/docs/kognic-io/calibration).

## [1.2.5] - 2022-08-18

### Changed

- Changed from `internalId` to `sceneUuid` on initialize input

### Bugfix

- Fixed error when using deprecated calibration model `annotell.input_api.model.calibration.sensors.CameraCalibration`
- We encourage updating to use the newer, typed calibration models in `annotell.input_api.model.calibration.{camera, lidar}.*`,
[refer to the calibration documentation for details](https://developers.kognic.com/docs/kognic-io/calibration).

## [1.2.4] - 2022-07-06

### Bugfix

- Fix bug where not specifying feature flags led to a runtime error.

## [1.2.3] - 2022-06-23

### Added

- Feature flags can be specified when creating inputs. This can be used to disable motion compensation.

## [1.2.2] - 2022-06-20

### Added

- Ability to specify field of view on LIDAR sensor calibrations.

## [1.2.1] - 2022-06-08

### Added
- Ability to create inputs from a scene
- Ability to create pre-annotations (limited support)

## [1.2.0] - 2022-05-05

### Changed
- `annotell-base-clients` is now a dependency for `annotell-input-api`, used for http requests and file uploads
- The generator produced by `client.annotation.get_project_annotations` will now reliably iterate projects with thousands of annotations

### Added
- Include `annotation_types` in `Input`
- Method to remove annotation types from an input: `remove_annotation_types`

## [1.1.5] - 2022-03-29

### Bugfix
- Added 'archived' as ProjectBatchStatus

## [1.1.4] - 2022-02-17

### Added

- MetaDataContainer added with reserved keyword `region`.
- Added ImageMetaData for shutter start and end times, used for high accuracy multi-sensor projections

## [1.1.3] - 2022-01-05

### Bugfix
- Fixed download of annotations

## [1.1.2] - 2021-12-03

### Changed

- Refactor of `file_resource_client.py`, split upload and download into separate classes.

### Added

- New parameter `timeout` to `InputApiClient`, which decides what the timeout in seconds is for calls to Annotell API:s and Google Cloud Storage.
- Retries when a `ConnectionError` is raised during uploading/downloading of resources to/from Google Cloud Storage.
- New input status `Pending`. An input will have this status if the input has been validated, but the server is waiting for the associated data to
be uploaded. When all data is uploaded the status of the input will change to `Processing`.

## [1.1.1] - 2021-11-11

### Changed

- Fixed import statement to work with python < 3.9

## [1.1.0] - 2021-11-03

### Added

- Two new methods has been added for downloading annotations: `client.annotation.get_annotation` and `client.annotation.get_project_annotations`. These two methods will serve annotations
in the OpenLABEL format. With this change the previous method for fetching annotations,
`client.annotation.get_annotations` has become deprecated.

- Stricter typing for the calibrations, specifically the camera calibrations. Each of the supported camera calibration models now have their own class in `annotell.input_api.model.calibration.camera`. Documentation regarding use can be found here: [Documentation](https://annotell.github.io/annotell-python/docs/input-api/calibration)
- Field of View support for camera calibrations
- New Parameter Xi for Fisheye camera calibration model

### Changed

- Two constructor arguments in `InputApiClient` and `FileResourceClient` have been renamed from `max_upload_retry_attemps`, `max_upload_retry_wait_time`
to `max_retry_attempts`, `max_retry_wait_time` respectively.

- The old camera calibration class will be deprecated in favour of the new classes

## [1.0.8] - 2021-09-07

### Added

- A new method has been added, `get_inputs_with_uuids`, which can fetch inputs using only the `input_uuid`.
- `annoutil` has a new flag when fetching inputs, `annoutil inputs --uuids <comma_separated_uuids>`.
- `lidars` and `lidars_sequence` inputs now available through the client.
- A new method has been added, `add_annotation_type`, which adds additional annotation types to be performed for an input.

### Changed

- `client.calibration.get_calibration()` now properly deserializes calibration into `SensorCalibrationEntry` instead of keeping it as a dict.

## [1.0.7] - 2021-06-11

### Added

- `created` timestamp when querying `get_inputs`
- Method `get_annotation_types`

### Changed

- `input_list_id` replaced with `annotation_types` for all createable resources (`Cameras`, `CamerasSeq`, `LidarsAndCameras`, `LidarsAndCamerasSeq`).

## [1.0.6] - 2021-05-28

### Added

- `calibration_id` now available for created inputs via the `client.input.get_inputs` method.
- It is now possible to create your project batches on your own using the
`client.project.create_batch` method. Please contact Annotell's Professional Services
before using. More information available in the [documentation](https://annotell.github.io/annotell-python/).

## [1.0.5] - 2021-05-06

### Changed

- Changed the height/width in the unity calibration created in the examples to match the image/videos.
- Added new field in the Input class, view_link. If the Input was successfully created it will contain an URL to view the input in the Annotell app.

### Bugfixes

- Fixed issue where `invalidate_inputs` did not properly discard response content.

## [1.0.4] - 2021-04-26

### Added

- Added support for providing metadata in the form of a flat KV-pair both on an input-level for all input types, as well as on a frame-level for all sequential input types.

### Changed

- Made SensorSpecification Optional for all input types

### Removed

- Removed sensor_settings from SensorSpecification. The pixel dimensions are now
automatically inferred from videos and images.

## [1.0.3] - 2021-04-14

### Added

- Added an example for download_annotations
- Added check so that `input_list_id` and `project` is not used simultaneously when creating inputs

### Changed

- Made client and file_client internal
- Fixed bug where client sometimes didn't raise exception when http calls return error codes
- Bugfix where annoutil didn't work due to missing import
- Clarified examples with different images/videos for different sensors and frames.

### Removed

- Removed unnecessary parameters `frame_id` and `relative_timestamp` from `lidars_and_cameras`

## [1.0.1] - 2021-04-06

- Use backport of `dataclasses` to support python 3.6.

## [1.0.0] - 2021-03-23

- New major release of client. Reworked to be more internally consistent between input types, and use of project and batch identifiers across methods. See [docs](https://annotell.github.io/annotell-python/) for more info.
- `client.lidar_and_cameras.create` replaces `client.create_inputs_point_cloud_with_images`
- `client.cameras.create` replaces `client.upload_and_create_images_input_job`
- `client.annotations.get_annotations` replaces `client.download_annotations`

## [0.4.4] - 2021-03-02

- Remove unused dependency on annotell-cloud-storage

## [0.4.3] - 2021-02-16

- Fixed import bug in annoutil CLI tool.

## [0.4.2] - 2021-02-02

### Changed

- Changed url for the `get_calibration_data` method. Does not affect
usage of the method in any way.

## [0.4.1] - 2021-01-29

### Changed

- Removed unused property `deadline` from project

## [0.4.0] - 2021-01-28

### Changed

- Renamed method `upload_and_create_images_input_job` to `create_inputs_images`.
- Renamed method `list_projects` to `get_projects`.
- Renamed method `list_project_batches` to `get_project_batches`.
- Changed behaviour of method `download_annotations`. The previously optional argumnet `request_id` has been removed. Additionally, the return
signature is changed to return a list of annotations for each input, instead of a dict as before.
- Behaviour of `get_inputs` has changed. It now receives `project` (identifier, not numerical id anymore), as well as three optional parameters `batch`, `external_ids` and `include_invalidated`. Returns all inputs belonging to the project, with the option of filtering on batch, external ID and whether or not including invalidated inputs. The returned list of classes had additional fields describing which batch each input belongs to, as well as their status (`created`, `processing`, `failed`, `invalidated`).
- Changed name of argument `input_ids` to `input_internal_ids` for method `invalidate_inputs`.
- Use backport of `dataclasses` to support python 3.6.
- Add missing dependency on `python-dateutil`.

### Removed

- Methods `count_inputs_for_external_ids`, `get_internal_ids_for_external_ids`, `mend_input_data`, `remove_inputs_from_input_list`, `list_input_lists`, `publish_batch`, `get_requests_for_request_ids`, `get_requests_for_input_lists`, `get_input_status`, `get_input_jobs_status`, `get_requests_for_project_id`, `get_datas_for_inputs_by_internal_ids` and `get_datas_for_inputs_by_external_ids` have all been removed.

## [0.3.12] - 2021-01-13

### Changed

- Removed getting started documentation from `README.md` and instead link to new docs.

## [0.3.11] - 2020-12-14

### Changed

- Deserialization bugfix in models for `InputBatch` and `InputBatch`.

## [0.3.10] - 2020-12-01

### Added

- Minor fix in annoutil

## [0.3.9] - 2020-11-26

### Added

- Bump of required python version to >=3.7
- New explicit models for `lidar` and `camera calibration` added.
- `publish_batch` which accepts project identifier and batch identifier and marks the batch as ready for annotation.

### Changed

- Deprecation warning for the old `lidar` and `camera calibration` models. No other change in functionality.

## [0.3.8] - 2020-11-13

### Added

- `get_inputs` which accepts a project ID or project identifier (external ID) and returns inputs connected to the project. `invalidated` filter parameter to optionally filter only invalidated inputs. Also exposed in annoutil as `annoutil projects 1 --invalidated`.

### Changed

- `invalidate_inputs` now accepts annotell `internal_ids (UUID)` instead of Annotell specific input ids.

## [0.3.7] - 2020-11-06

### Changed

- bug fix related to oauth session

## [0.3.6] - 2020-11-02

### Changed

- SLAM - add cuboid timespans, `dynamic_objects` not includes both `cuboids` and `cuboid_timespans`

## [0.3.5] - 2020-10-19

### Added

- Add support for `project` and `batch` identifiers for input request.
Specifying project and batch adds input to specified batch.
When only sending project, inputs are added to the latest open batch for the project.

### Deprecated

- `input_list_id` will be removed in the 0.4.x version

## [0.3.4] - 2020-09-10

### Changed

- SLAM - add required `sub_sequence_id` and optional `settings`

## [0.3.3] - 2020-09-10

### Changed

- SLAM - add required `sequence_id`

## [0.3.2] - 2020-09-01

### Changed

- SLAM - startTs and endTs not optional in Slam request

## [0.3.1] - 2020-07-16

### Changed

- If the upload of point clouds or images crashes and returns status code 429, 408 or 5xx the script will
retry the upload before crashing. The default settings may be changed when initializing the `InputApiClient`
by specifying values to the `max_upload_retry_attempts` and `max_upload_retry_wait_time` parameters.

## [0.3.0] - 2020-07-03

### Changed

- The method `create_inputs_point_cloud_with_images` in `InputApiClient` now takes an extra parameter: `dryrun: bool`.
If set to `True` all the validation checks will be run but no inputJob will be created, and
if it is set to `False` an inputJob will be created if the validation checks all pass.

### Bugfixes

- Fixed bug where the uploading of .csv files to GCS crashed if run on some windows machines.

## [0.2.9] - 2020-07-02

### Added

- New public method in `InputApiClient`: `count_inputs_for_external_ids`.

## [0.2.8] - 2020-06-30

### Added

- Docstrings for all public methods in the `InputApiClient` class

## [0.2.7] - 2020-06-29

### Added

- Require time specification to be send when posting slam requests

## [0.2.6] - 2020-06-26

### Changed

- Removed `CalibrationSpec` from `CalibratedSceneMetaData` and `SlamMetaData`. Updated
so that `create_calibration_data` in `InputApiClient` only takes a `CalibrationSpec`
as parameter.

## [0.2.5] - 2020-06-22

### Bugfixes

- Fixed issue where a path including a "~" would not expand correctly.

## [0.2.4] - 2020-06-17

### Changed

- Changed pointcloud_with_images model. Images and point clouds are now represented as `Image` and `PointCloud` containing filename and source. Consequently, `images_to_source` is removed from `SourceSpecification`.

### Added

- create Image inputs via `create_images_input_job`
- It's now possible to invalidate erroneous inputs via `invalidate_inputs`
- Support for removing specific inputs via `remove_inputs_from_input_list`
- SLAM support (not generally available)

### Bugfixes

- Fixed issue where annoutils would not deserialize datas correctly when querying datas by internalId

## [0.2.3] - 2020-04-21

### Changed

- Changed how timestamps are represented when receiving responses.

## [0.2.2] - 2020-04-17

### Added

- Methods `get_datas_for_inputs_by_internal_ids` and `get_datas_for_inputs_by_external_ids` can be used to get which `Data` are part of an `Input`, useful in order to check which images, lidar-files have been uploaded. Both are also available in the CLI via :

```console
$ annoutil inputs --get-datas <internal_ids>
$ annoutil inputs-externalid --get-datas <external_ids>
```

- Support has been added for `Kannala` camera types. Whenever adding calibration for `Kannala` undistortion coefficients must also be added.
- Calibration is now represented as a class and is no longer just a dictionary, making it easier to understand how the Annotell format is structured and used.

## [0.2.0] - 2020-04-16

### Changed

- Change constructor to disable legacy api token support and only accept an `auth` parameter

## [0.1.5] - 2020-04-07

### Added

- Method `get_input_jobs_status` now accepts lists of internal_ids and external_ids as arguments.

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "kognic-io",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "Kognic,API",
    "author": "",
    "author_email": "Kognic <scenes-and-predictions@kognic.com>",
    "download_url": "https://files.pythonhosted.org/packages/5a/ea/cca9be69f4a3bcc75fc80eecaccee1f0b545a00ffc85edb889089bb2d8ae/kognic-io-2.1.2.tar.gz",
    "platform": null,
    "description": "# Kognic IO Client\n\nPython 3 library providing access to Kognic IO\n\nTo install with pip run `pip install kognic-io`\n\n# Documentation & Getting Started Guide\n\nDocumentation about how to use the library can be found [here](https://developers.kognic.com/)\n\n# Changelog\n\nAll notable changes to this project will be documented in this file.\n\n## [2.1.2] - 2024-02-27\n\n- Bump dependency on `kognic-base-clients` to `2.3.4`\n\n## [2.1.1] - 2024-02-21\n\n- add `max_connection` parameter in resource clients to allow for more control over the number of network connections\n\n## [2.1.0] - 2024-01-30\n\n- add API client to order-execution-api, including kognic-io client parameter to override order_execution_api_host\n\n## [2.0.1] - 2023-11-22\n\n- Default values on `Optional` fields to handle pydantic v2.0.0\n- Adds scene_external_id to the pydantic input model\n\n## [2.0.0] - 2023-11-17\n\n- Bumped pydantic to v2. No breaking changes in the kognic-io interface, but if you are using pydantic directly you may need to update your code.  \n\n## [1.8.0] - 2023-10-31\n\n### Added\n\n- Utilities for custom camera calibrations\n  - `kognic.io.tools.calibration.validation` for validating custom camera calibrations\n  - `kognic.io.tools.calibration.compilation` for compiling custom camera calibrations to WebAssembly\n\n\n## [1.7.0] - 2023-10-18\n\n### Added\n\n- Method to query request inputs, use it with `client.input.query_inputs(...)`\n- `create_from_scene(...)` now returns created inputs\n- New `Input` model representing a scene in a request\n- Modelling for `CustomCameraCalibration` using WebAssembly\n\n### Deprecated\n\n- The method `get_inputs_with_uuids` (use `get_scenes_by_uuids` instead)\n- The method `get_inputs` (use `query_inputs` instead)\n- The old `kognic.io.model.input.input_entry.Input` model along with `kognic.io.model.input.input_entry.InputStatus`\n\n## [1.6.0] - 2023-10-06\n\n### Added\n\n- Method to get scenes by uuids, use it with `client.scene.get_scenes_by_uuids([...])`\n- Method to get an annotation by input uuid `client.annotation.get_annotation_for_input(input_uuid)`\n- Method to get all annotations for a scene `client.annotation.get_annotations_for_scene(scene_uuid)`\n- Method to invalidate scenes `client.scene.invalidate_scenes([scene_uuid, ...], reason)`\n- Method to delete an input `client.input.delete_input(input_uuid)`\n\n### Changed\n\n- Renamed `input_type` field on `Input` to `scene_type`\n- Renamed `input_uuid` to `scene_uuid` on the following methods\n  - `client.annotation.get_annotation`\n  - `client.input.invalidate_inputs`\n  - `client.input.add_annotation_type`\n  - `client.input.remove_annotation_types`\n  - `client.input.get_inputs_by_uuids`\n- Renamed `input_uuid` parameter in `get_annotation` to `scene_uuid`\n\n### Deprecated\n\n- The method `invalidate_inputs` (use `invalidate_scenes` instead)\n- The method `remove_annotation_types` (use `delete_input` instead)\n- `input_type` on the `Input` model (use `scene_type` instead)\n- `input_uuid` parameter in favour of `scene_uuid` on the following methods\n  - `client.annotation.get_annotation`\n  - `client.input.invalidate_inputs`\n  - `client.input.add_annotation_type`\n  - `client.input.remove_annotation_types`\n  - `client.input.get_inputs_by_uuids`\n\n## [1.5.0] - 2023-09-29\n\n### Added\n\n- Support for asynchronous callbacks in `FileData`\n\n\n## [1.4.0] - 2023-09-22\n\n### Added\n\n- Added missing `FileData.Format.WEBP` to enable use of WebP for `FileData` images (which were already supported for `InputModel.Image`)\n- Support for new camera model named custom.\n\n### Changed\n\n- Renamed `lidar_and_cameras` attribute to `lidars_and_cameras` on `KognicIOClient`\n- Renamed `uuid` field on `Input` to `scene_uuid`\n- Renamed `input_uuid` field on `Annotation` to `scene_uuid`\n- Renamed response from `create` method from `CreateInputResponse` to `CreateSceneResponse`. Also renamed `input_uuid` field to `scene_uuid` in the response.\n- Renamed `InvalidatedReasonInput` to `InvalidatedReasonScene`\n- Moved all scene models (for example `LidarsAndCameras`) from `kognic.io.model.input` to `kognic.io.model.scene`\n\n### Deprecated (will be removed in a future release)\n\n- `lidar_and_cameras` attribute on `KognicIOClient`\n- `uuid` field on `Input`\n- `input_uuid` field on `Annotation`\n- `CreateInputResponse` response from `create` method along with its `input_uuid` field\n- `InvalidatedReasonInput`\n- Scene models in `kognic.io.model.input`\n\n## [1.3.0] - 2023-08-08\n\n### Changed\n\n- Validate that all required local image and pointcloud files exist before beginning to create scenes.\n    - Validation errors will be raised for missing or empty files.\n    - `Image` and `PointCloud` `filename` must refer to a file that exists & contain data unless a callback or raw bytes are provided.\n       (i.e. there is no validation any time `FileData` are used)\n- Support for new camera model named Principal Point Fisheye model. \n\n## [1.2.2] - 2023-07-05\n\n### Changed\n\n- Pin pydantic version to <2\n- Remove dependency on `Pillow`\n\n## [1.2.1] - 2023-05-19\n\n### Added\n\n- Add optional attribute max_altitude_angle to fused cylindrical camera model\n\n## [1.2.0] - 2023-05-09\n\n### Added\n\n- Support for new camera model named Cylindrical model.\n\n### Bugfix\n\n- Fixed bug where the calibration types were not used coherently across different calibration models. This resulted in check such as `if calibration.calibration_type == CalibrationType.PINHOLE` to fail in some cases.\n\n## [1.1.9] - 2023-04-12\n\n### Added\n\n- Wrapper function `create_inputs` that allows creation of multiple inputs (with or without a pre-annotation) with a single call. This is useful since it contains wait-logic for the scene to be ready before creating inputs.\n\n## [1.1.8] - 2023-03-17\n\n### Added\n\n- Support for custom lens projection coefficients for Principal Point Distortion model. \n\n## [1.1.6] - 2023-03-14\n\n### Added\n\n- Support for new camera model named Fused Cylindrical model. \n\n### Changed\n\n- Fixed bug where files intended to be uploaded using data from a callback or in-memory blob would sometimes be incorrectly handled if their callback or blob could be coerced to `False`.\n\n## [1.1.5] - 2023-01-20\n\n### Added\n\n- Support for the new input type `aggregated_lidars_and_cameras_sequence`. This new input type is a sequence of cameras\n  and point clouds, but the point clouds are aggregated over time. More information can be found [here](https://developers.kognic.com/docs/kognic-io/inputs/aggregated_lidars_and_cameras_seq).\n- New parameter `include_content` in `get_project_annotations` that lets you choose whether to fetch the annotation content\n  or not\n\n\n## [1.1.4] - 2022-12-02\n\n### Changed\n\n- Bumped dependency on `kognic-base-clients` to `1.0.3` which introduces retry when uploads fail for TCP or SSL timeout reasons.\n\n## [1.1.2] - 2022-11-25\n\n### Changed\n\n- Fixed issue with parsing of custom metadata fields\n\n## [1.1.1] - 2022-11-11\n\n### Added\n\n- The raw bytes for each scene resource (`Image`, `PointCloud`) may now be provided in different ways:\n    - read from a local file, as before (no changes are needed to continue using this behaviour)\n    - passed directly when creating the resource\n    - loaded progressively during the upload via a callback\n\nRefer to [the updated documentation](https://developers.kognic.com/docs/kognic-io/overview#image--pointcloud-resources)\nfor details about how to use the new API features.\n\n### Changed\n\n- `metadata` is once again an optional attribute on model classes that use it (`CamerasSequence` among others)\n\n## [1.0.2] - 2022-11-01\n\n### Changed\n- Bumped dependency on `kognic-base-clients` to `1.0.1`\n- Added pagination to the `get_inputs` method to prevent timeouts\n\n\n### Bugfix\n- Metadata should default to an empty dict\n\n## [1.0.1] - 2022-10-18\n\n- Updated readme\n\n## [1.0.0] - 2022-10-18\n\nThis is a major release with breaking changes and refactorings.\nPlease refer to our Annotell-2-Kognic [migration guide](https://developers.kognic.com/docs/a2k_migration_guide)\nfor details.\n\n### Changed\n- Annotell becomes Kognic\n- Bumped minimum python version from 3.6 to 3.7\n- Packaging changes\n- Remaining `@dataclass`es in our model packages are now pydantic models with better validation\n\n\n### Removed\n- Deprecated calibration models\n- Deprecated `get_annotations` method\n\n---\n\n# Changelog (before rebranding)\n\n## [1.3.1] - 2022-09-13\n\n### Bugfix\n- Changed naming in PrincipalPointDistortionCalibration \n\n## [1.3.0] - 2022-09-09\n\n### Changed\n- Added PrincipalPointDistortionCalibration\n\n## [1.2.6] - 2022-08-19\n\n### Bugfix\n\n- Fixed error when using deprecated calibration model `annotell.input_api.model.calibration.sensors.LidarCalibration`\n    - We encourage updating to use the newer, typed calibration models in `annotell.input_api.model.calibration.{camera, lidar}.*`,\n      [refer to the calibration documentation for details](https://developers.kognic.com/docs/kognic-io/calibration).\n\n## [1.2.5] - 2022-08-18\n\n### Changed\n\n- Changed from `internalId` to `sceneUuid` on initialize input\n\n### Bugfix\n\n- Fixed error when using deprecated calibration model `annotell.input_api.model.calibration.sensors.CameraCalibration`\n    - We encourage updating to use the newer, typed calibration models in `annotell.input_api.model.calibration.{camera, lidar}.*`,\n      [refer to the calibration documentation for details](https://developers.kognic.com/docs/kognic-io/calibration).\n\n## [1.2.4] - 2022-07-06\n\n### Bugfix\n\n- Fix bug where not specifying feature flags led to a runtime error.\n\n## [1.2.3] - 2022-06-23\n\n### Added\n\n- Feature flags can be specified when creating inputs. This can be used to disable motion compensation.\n\n## [1.2.2] - 2022-06-20\n\n### Added\n\n- Ability to specify field of view on LIDAR sensor calibrations.\n\n## [1.2.1] - 2022-06-08\n\n### Added\n- Ability to create inputs from a scene\n- Ability to create pre-annotations (limited support)\n\n## [1.2.0] - 2022-05-05\n\n### Changed\n- `annotell-base-clients` is now a dependency for `annotell-input-api`, used for http requests and file uploads\n- The generator produced by `client.annotation.get_project_annotations` will now reliably iterate projects with thousands of annotations\n\n### Added\n- Include `annotation_types` in `Input`\n- Method to remove annotation types from an input: `remove_annotation_types`\n\n## [1.1.5] - 2022-03-29\n\n### Bugfix\n- Added 'archived' as ProjectBatchStatus\n\n## [1.1.4] - 2022-02-17\n\n### Added\n\n- MetaDataContainer added with reserved keyword `region`. \n- Added ImageMetaData for shutter start and end times, used for high accuracy multi-sensor projections\n\n## [1.1.3] - 2022-01-05\n\n### Bugfix\n- Fixed download of annotations\n\n## [1.1.2] - 2021-12-03\n\n### Changed\n\n- Refactor of `file_resource_client.py`, split upload and download into separate classes.\n\n### Added\n\n- New parameter `timeout` to `InputApiClient`, which decides what the timeout in seconds is for calls to Annotell API:s and Google Cloud Storage.\n- Retries when a `ConnectionError` is raised during uploading/downloading of resources to/from Google Cloud Storage.\n- New input status `Pending`. An input will have this status if the input has been validated, but the server is waiting for the associated data to\n  be uploaded. When all data is uploaded the status of the input will change to `Processing`.\n\n## [1.1.1] - 2021-11-11\n\n### Changed\n\n- Fixed import statement to work with python < 3.9\n\n## [1.1.0] - 2021-11-03\n\n### Added\n\n- Two new methods has been added for downloading annotations: `client.annotation.get_annotation` and `client.annotation.get_project_annotations`. These two methods will serve annotations\n  in the OpenLABEL format. With this change the previous method for fetching annotations,\n  `client.annotation.get_annotations` has become deprecated.\n\n- Stricter typing for the calibrations, specifically the camera calibrations. Each of the supported camera calibration models now have their own class in `annotell.input_api.model.calibration.camera`. Documentation regarding use can be found here: [Documentation](https://annotell.github.io/annotell-python/docs/input-api/calibration)\n- Field of View support for camera calibrations\n- New Parameter Xi for Fisheye camera calibration model\n\n### Changed\n\n- Two constructor arguments in `InputApiClient` and `FileResourceClient` have been renamed from `max_upload_retry_attemps`, `max_upload_retry_wait_time`\n  to `max_retry_attempts`, `max_retry_wait_time` respectively.\n\n- The old camera calibration class will be deprecated in favour of the new classes\n\n## [1.0.8] - 2021-09-07\n\n### Added\n\n- A new method has been added, `get_inputs_with_uuids`, which can fetch inputs using only the `input_uuid`.\n- `annoutil` has a new flag when fetching inputs, `annoutil inputs --uuids <comma_separated_uuids>`.\n- `lidars` and `lidars_sequence` inputs now available through the client.\n- A new method has been added, `add_annotation_type`, which adds additional annotation types to be performed for an input.\n\n### Changed\n\n- `client.calibration.get_calibration()` now properly deserializes calibration into `SensorCalibrationEntry` instead of keeping it as a dict.\n\n## [1.0.7] - 2021-06-11\n\n### Added\n\n- `created` timestamp when querying `get_inputs`\n- Method `get_annotation_types`\n\n### Changed\n\n- `input_list_id` replaced with `annotation_types` for all createable resources (`Cameras`, `CamerasSeq`, `LidarsAndCameras`, `LidarsAndCamerasSeq`).\n\n## [1.0.6] - 2021-05-28\n\n### Added\n\n- `calibration_id` now available for created inputs via the `client.input.get_inputs` method.\n- It is now possible to create your project batches on your own using the\n  `client.project.create_batch` method. Please contact Annotell's Professional Services\n  before using. More information available in the [documentation](https://annotell.github.io/annotell-python/).\n\n## [1.0.5] - 2021-05-06\n\n### Changed\n\n- Changed the height/width in the unity calibration created in the examples to match the image/videos.\n- Added new field in the Input class, view_link. If the Input was successfully created it will contain an URL to view the input in the Annotell app.\n\n### Bugfixes\n\n- Fixed issue where `invalidate_inputs` did not properly discard response content.\n\n## [1.0.4] - 2021-04-26\n\n### Added\n\n- Added support for providing metadata in the form of a flat KV-pair both on an input-level for all input types, as well as on a frame-level for all sequential input types.\n\n### Changed\n\n- Made SensorSpecification Optional for all input types\n\n### Removed\n\n- Removed sensor_settings from SensorSpecification. The pixel dimensions are now\n  automatically inferred from videos and images.\n\n## [1.0.3] - 2021-04-14\n\n### Added\n\n- Added an example for download_annotations\n- Added check so that `input_list_id` and `project` is not used simultaneously when creating inputs\n\n### Changed\n\n- Made client and file_client internal\n- Fixed bug where client sometimes didn't raise exception when http calls return error codes\n- Bugfix where annoutil didn't work due to missing import\n- Clarified examples with different images/videos for different sensors and frames.\n\n### Removed\n\n- Removed unnecessary parameters `frame_id` and `relative_timestamp` from `lidars_and_cameras`\n\n## [1.0.1] - 2021-04-06\n\n- Use backport of `dataclasses` to support python 3.6.\n\n## [1.0.0] - 2021-03-23\n\n- New major release of client. Reworked to be more internally consistent between input types, and use of project and batch identifiers across methods. See [docs](https://annotell.github.io/annotell-python/) for more info.\n- `client.lidar_and_cameras.create` replaces `client.create_inputs_point_cloud_with_images`\n- `client.cameras.create` replaces `client.upload_and_create_images_input_job`\n- `client.annotations.get_annotations` replaces `client.download_annotations`\n\n## [0.4.4] - 2021-03-02\n\n- Remove unused dependency on annotell-cloud-storage\n\n## [0.4.3] - 2021-02-16\n\n- Fixed import bug in annoutil CLI tool.\n\n## [0.4.2] - 2021-02-02\n\n### Changed\n\n- Changed url for the `get_calibration_data` method. Does not affect\n  usage of the method in any way.\n\n## [0.4.1] - 2021-01-29\n\n### Changed\n\n- Removed unused property `deadline` from project\n\n## [0.4.0] - 2021-01-28\n\n### Changed\n\n- Renamed method `upload_and_create_images_input_job` to `create_inputs_images`.\n- Renamed method `list_projects` to `get_projects`.\n- Renamed method `list_project_batches` to `get_project_batches`.\n- Changed behaviour of method `download_annotations`. The previously optional argumnet `request_id` has been removed. Additionally, the return\n  signature is changed to return a list of annotations for each input, instead of a dict as before.\n- Behaviour of `get_inputs` has changed. It now receives `project` (identifier, not numerical id anymore), as well as three optional parameters `batch`, `external_ids` and `include_invalidated`. Returns all inputs belonging to the project, with the option of filtering on batch, external ID and whether or not including invalidated inputs. The returned list of classes had additional fields describing which batch each input belongs to, as well as their status (`created`, `processing`, `failed`, `invalidated`).\n- Changed name of argument `input_ids` to `input_internal_ids` for method `invalidate_inputs`.\n- Use backport of `dataclasses` to support python 3.6.\n- Add missing dependency on `python-dateutil`.\n\n### Removed\n\n- Methods `count_inputs_for_external_ids`, `get_internal_ids_for_external_ids`, `mend_input_data`, `remove_inputs_from_input_list`, `list_input_lists`, `publish_batch`, `get_requests_for_request_ids`, `get_requests_for_input_lists`, `get_input_status`, `get_input_jobs_status`, `get_requests_for_project_id`, `get_datas_for_inputs_by_internal_ids` and `get_datas_for_inputs_by_external_ids` have all been removed.\n\n## [0.3.12] - 2021-01-13\n\n### Changed\n\n- Removed getting started documentation from `README.md` and instead link to new docs.\n\n## [0.3.11] - 2020-12-14\n\n### Changed\n\n- Deserialization bugfix in models for `InputBatch` and `InputBatch`.\n\n## [0.3.10] - 2020-12-01\n\n### Added\n\n- Minor fix in annoutil\n\n## [0.3.9] - 2020-11-26\n\n### Added\n\n- Bump of required python version to >=3.7\n- New explicit models for `lidar` and `camera calibration` added.\n- `publish_batch` which accepts project identifier and batch identifier and marks the batch as ready for annotation.\n\n### Changed\n\n- Deprecation warning for the old `lidar` and `camera calibration` models. No other change in functionality.\n\n## [0.3.8] - 2020-11-13\n\n### Added\n\n- `get_inputs` which accepts a project ID or project identifier (external ID) and returns inputs connected to the project. `invalidated` filter parameter to optionally filter only invalidated inputs. Also exposed in annoutil as `annoutil projects 1 --invalidated`.\n\n### Changed\n\n- `invalidate_inputs` now accepts annotell `internal_ids (UUID)` instead of Annotell specific input ids.\n\n## [0.3.7] - 2020-11-06\n\n### Changed\n\n- bug fix related to oauth session\n\n## [0.3.6] - 2020-11-02\n\n### Changed\n\n- SLAM - add cuboid timespans, `dynamic_objects` not includes both `cuboids` and `cuboid_timespans`\n\n## [0.3.5] - 2020-10-19\n\n### Added\n\n- Add support for `project` and `batch` identifiers for input request.\n  Specifying project and batch adds input to specified batch.\n  When only sending project, inputs are added to the latest open batch for the project.\n\n### Deprecated\n\n- `input_list_id` will be removed in the 0.4.x version\n\n## [0.3.4] - 2020-09-10\n\n### Changed\n\n- SLAM - add required `sub_sequence_id` and optional `settings`\n\n## [0.3.3] - 2020-09-10\n\n### Changed\n\n- SLAM - add required `sequence_id`\n\n## [0.3.2] - 2020-09-01\n\n### Changed\n\n- SLAM - startTs and endTs not optional in Slam request\n\n## [0.3.1] - 2020-07-16\n\n### Changed\n\n- If the upload of point clouds or images crashes and returns status code 429, 408 or 5xx the script will\n  retry the upload before crashing. The default settings may be changed when initializing the `InputApiClient`\n  by specifying values to the `max_upload_retry_attempts` and `max_upload_retry_wait_time` parameters.\n\n## [0.3.0] - 2020-07-03\n\n### Changed\n\n- The method `create_inputs_point_cloud_with_images` in `InputApiClient` now takes an extra parameter: `dryrun: bool`.\n  If set to `True` all the validation checks will be run but no inputJob will be created, and\n  if it is set to `False` an inputJob will be created if the validation checks all pass.\n\n### Bugfixes\n\n- Fixed bug where the uploading of .csv files to GCS crashed if run on some windows machines.\n\n## [0.2.9] - 2020-07-02\n\n### Added\n\n- New public method in `InputApiClient`: `count_inputs_for_external_ids`.\n\n## [0.2.8] - 2020-06-30\n\n### Added\n\n- Docstrings for all public methods in the `InputApiClient` class\n\n## [0.2.7] - 2020-06-29\n\n### Added\n\n- Require time specification to be send when posting slam requests\n\n## [0.2.6] - 2020-06-26\n\n### Changed\n\n- Removed `CalibrationSpec` from `CalibratedSceneMetaData` and `SlamMetaData`. Updated\n  so that `create_calibration_data` in `InputApiClient` only takes a `CalibrationSpec`\n  as parameter.\n\n## [0.2.5] - 2020-06-22\n\n### Bugfixes\n\n- Fixed issue where a path including a \"~\" would not expand correctly.\n\n## [0.2.4] - 2020-06-17\n\n### Changed\n\n- Changed pointcloud_with_images model. Images and point clouds are now represented as `Image` and `PointCloud` containing filename and source. Consequently, `images_to_source` is removed from `SourceSpecification`.\n\n### Added\n\n- create Image inputs via `create_images_input_job`\n- It's now possible to invalidate erroneous inputs via `invalidate_inputs`\n- Support for removing specific inputs via `remove_inputs_from_input_list`\n- SLAM support (not generally available)\n\n### Bugfixes\n\n- Fixed issue where annoutils would not deserialize datas correctly when querying datas by internalId\n\n## [0.2.3] - 2020-04-21\n\n### Changed\n\n- Changed how timestamps are represented when receiving responses.\n\n## [0.2.2] - 2020-04-17\n\n### Added\n\n- Methods `get_datas_for_inputs_by_internal_ids` and `get_datas_for_inputs_by_external_ids` can be used to get which `Data` are part of an `Input`, useful in order to check which images, lidar-files have been uploaded. Both are also available in the CLI via :\n\n```console\n$\u00a0annoutil inputs --get-datas <internal_ids>\n$\u00a0annoutil inputs-externalid --get-datas <external_ids>\n```\n\n- Support has been added for `Kannala` camera types. Whenever adding calibration for `Kannala` undistortion coefficients must also be added.\n- Calibration is now represented as a class and is no longer just a dictionary, making it easier to understand how the Annotell format is structured and used.\n\n## [0.2.0] - 2020-04-16\n\n### Changed\n\n- Change constructor to disable legacy api token support and only accept an `auth` parameter\n\n## [0.1.5] - 2020-04-07\n\n### Added\n\n- Method `get_input_jobs_status` now accepts lists of internal_ids and external_ids as arguments.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Kognic IO Client",
    "version": "2.1.2",
    "project_urls": {
        "homepage": "https://github.com/annotell/kognic-io-python"
    },
    "split_keywords": [
        "kognic",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6e7f52ce8a0c527748aec570bf5d9b86b9b644f315199e571582d84a2f894b02",
                "md5": "49c10f6038efd974cfa41ad551d48612",
                "sha256": "cbf9f5f0b0b76fc4dcfd59a6338cb374830e2cc5aefe21f8c39de83c6f5770d1"
            },
            "downloads": -1,
            "filename": "kognic_io-2.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "49c10f6038efd974cfa41ad551d48612",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 87143,
            "upload_time": "2024-02-27T15:54:41",
            "upload_time_iso_8601": "2024-02-27T15:54:41.521475Z",
            "url": "https://files.pythonhosted.org/packages/6e/7f/52ce8a0c527748aec570bf5d9b86b9b644f315199e571582d84a2f894b02/kognic_io-2.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5aeacca9be69f4a3bcc75fc80eecaccee1f0b545a00ffc85edb889089bb2d8ae",
                "md5": "2d32b397962a28f886fb155dc2396080",
                "sha256": "5e66a4e17b7b39e2b4e7920b7ddfd7856bf09598f7575edc81c49ad318a2c346"
            },
            "downloads": -1,
            "filename": "kognic-io-2.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "2d32b397962a28f886fb155dc2396080",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 13091772,
            "upload_time": "2024-02-27T15:54:43",
            "upload_time_iso_8601": "2024-02-27T15:54:43.936095Z",
            "url": "https://files.pythonhosted.org/packages/5a/ea/cca9be69f4a3bcc75fc80eecaccee1f0b545a00ffc85edb889089bb2d8ae/kognic-io-2.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-27 15:54:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "annotell",
    "github_project": "kognic-io-python",
    "github_not_found": true,
    "lcname": "kognic-io"
}