picteus-ws-client

The Picteus API

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.20.0
  • Package version: 0.20.0
  • Generator version: 7.17.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.linkedin.com/in/edouardmercier

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/picteus/picteus.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/picteus/picteus.git)

Then import the package:

import picteus_ws_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import picteus_ws_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import picteus_ws_client
from picteus_ws_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://localhost:3001
# See configuration.py for a list of all supported configuration parameters.
configuration = picteus_ws_client.Configuration(
    host = "https://localhost:3001"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api-key
configuration.api_key['api-key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'


# Enter a context with an instance of the API client
with picteus_ws_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = picteus_ws_client.AdministrationApi(api_client)

    try:
        # Migrates the database
        api_instance.administration_migrate_database()
    except ApiException as e:
        print("Exception when calling AdministrationApi->administration_migrate_database: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost:3001

Class Method HTTP request Description
AdministrationApi administration_migrate_database PUT /administration/migrateDatabase Migrates the database
ApiSecretApi apisecret_create POST /apiSecret/create Creates an API secret
ApiSecretApi apisecret_delete DELETE /apiSecret/{id}/delete Deletes an API secret
ApiSecretApi apisecret_get GET /apiSecret/{id}/get Gets an API secret
ApiSecretApi apisecret_list GET /apiSecret/list Lists all API secrets
CollectionApi collection_create POST /collection/create Creates a collection
CollectionApi collection_delete DELETE /collection/{id}/delete Deletes collection
CollectionApi collection_get GET /collection/{id}/get Gets a collection
CollectionApi collection_list GET /collection/list Lists all collections
CollectionApi collection_update PUT /collection/{id}/update Updates a collection
ExtensionApi extension_activities GET /extension/activities Indicates the extension activities
ExtensionApi extension_build PUT /extension/build Builds an extension
ExtensionApi extension_change_state PUT /extension/{id}/changeState Changes the state of an extension
ExtensionApi extension_compile PUT /extension/{id}/compile Compiles an extension
ExtensionApi extension_generate PUT /extension/generate Generates an extension
ExtensionApi extension_get GET /extension/{id}/get Gets an extension
ExtensionApi extension_get_configuration GET /extension/getConfiguration Provides the extensions configuration
ExtensionApi extension_get_settings GET /extension/{id}/getSettings Gets an extension settings
ExtensionApi extension_install POST /extension/install Installs an extension
ExtensionApi extension_install_chrome_extension PUT /extension/{id}/installChromeExtension Installs a Chrome extension
ExtensionApi extension_list GET /extension/list Lists all extensions
ExtensionApi extension_reset_settings PUT /extension/{id}/resetSettings Resets the settings of an extension
ExtensionApi extension_run_image_command PUT /extension/{id}/runImageCommand Runs a command exposed by an extension, on images
ExtensionApi extension_run_process_command PUT /extension/{id}/runProcessCommand Runs a command exposed by an extension, on the process
ExtensionApi extension_set_settings PUT /extension/{id}/setSettings Sets an extension settings
ExtensionApi extension_synchronize PUT /extension/{id}/synchronize Synchronizes the images via an extension
ExtensionApi extension_uninstall DELETE /extension/{id}/uninstall Uninstalls an extension
ExtensionApi extension_update PUT /extension/{id}/update Updates an extension
ImageApi image_closest_embeddings_images PUT /image/closestEmbeddingsImages Gets the closest images to some embeddings attached to an extension
ImageApi image_closest_images GET /image/{id}/closestImages Gets the image closest images
ImageApi image_compute_format PUT /image/format Computes the format of an image
ImageApi image_convert PUT /image/convert Converts an image into a format
ImageApi image_delete DELETE /image/{id}/delete Deletes an image
ImageApi image_download GET /image/{id}/download Downloads an image
ImageApi image_ensure_tags PUT /image/{id}/ensureTags Ensures that the tags are set on an image
ImageApi image_get GET /image/{id}/get Gets an image
ImageApi image_get_all_embeddings GET /image/{id}/getAllEmbeddings Gets all the embeddings of an image
ImageApi image_get_all_features GET /image/{id}/getAllFeatures Gets all the features of an image
ImageApi image_get_all_recipes GET /image/{id}/getAllRecipes Gets all the recipes of an image
ImageApi image_get_all_tags GET /image/{id}/getAllTags Gets all the tags of an image
ImageApi image_get_collection_ids GET /image/{id}/collectionIds Gets the identifiers of the image collections
ImageApi image_get_embeddings GET /image/{id}/getEmbeddings Gets the embeddings of an image
ImageApi image_get_features GET /image/{id}/getFeatures Gets all the features of an image for an extension
ImageApi image_get_metadata GET /image/{id}/metadata Gets the metadata of an image
ImageApi image_get_tags GET /image/{id}/getTags Gets the tags of an image for an extension
ImageApi image_media_url GET /image/{id}/mediaUrl Gets an URL of the image
ImageApi image_modify PUT /image/{id}/modify Modifies an image
ImageApi image_run_capabilities PUT /image/{id}/runCapabilities Runs capabilities on an image
ImageApi image_search_features POST /image/search/features Retrieves image features
ImageApi image_search_ids POST /image/search/ids Retrieves image ids
ImageApi image_search_images POST /image/search/images Retrieves image details
ImageApi image_search_media_url POST /image/search/mediaUrls Retrieves image media URLs
ImageApi image_search_run_capabilities PUT /image/search/runCapabilities Run capabilities on images
ImageApi image_search_summaries POST /image/search/summaries Retrieves image summaries
ImageApi image_search_tags POST /image/search/tags Retrieves image tags
ImageApi image_set_embeddings PUT /image/{id}/setEmbeddings Sets the embeddings of an image
ImageApi image_set_features PUT /image/{id}/setFeatures Sets the features of an image
ImageApi image_set_tags PUT /image/{id}/setTags Sets the tags of an image
ImageApi image_text_to_images GET /image/textToImages Gets the closest images to a text following the embeddings of an extension
ImageAttachmentApi imageattachment_create POST /imageAttachment/create Declares an image binary attachment
ImageAttachmentApi imageattachment_download GET /imageAttachment/{uri}/download Downloads an image binary attachment
MiscellaneousApi miscellaneous_get_configuration GET /miscellaneous/configuration Gets the application configuration
MiscellaneousApi miscellaneous_ping GET /miscellaneous/ping Pings the service
RepositoryApi repository_activities GET /repository/activities Indicates the repositories activities
RepositoryApi repository_create POST /repository/create Creates a repository
RepositoryApi repository_delete DELETE /repository/{id}/delete Deletes a repository
RepositoryApi repository_ensure PUT /repository/ensure Ensures a repository exists
RepositoryApi repository_get GET /repository/{id}/get Gets a repository
RepositoryApi repository_get_embeddings_names GET /repository/embeddingsNames Gets all the embeddings identifiers and names
RepositoryApi repository_get_feature_names GET /repository/featureNames Gets all the feature names
RepositoryApi repository_get_image_by_url GET /repository/getImageByUrl Gets an image from its URL
RepositoryApi repository_get_tags GET /repository/tags Gets all the tags
RepositoryApi repository_list GET /repository/list Lists repositories
RepositoryApi repository_rename_image PUT /repository/{id}/renameImage Renames an image
RepositoryApi repository_start_or_stop PUT /repository/startOrStop Starts or stop the repositories
RepositoryApi repository_store_image POST /repository/{id}/storeImage Creates an image in the repository
RepositoryApi repository_synchronize PUT /repository/{id}/synchronize Synchronizes a repository
RepositoryApi repository_update PUT /repository/{id}/update Updates a repository
RepositoryApi repository_watch PUT /repository/{id}/watch Starts or stops watching a repository
SettingsApi settings_get GET /settings/get Gets all the settings
SettingsApi settings_set PUT /settings/set Sets all the settings

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api-key

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

Author

edouard@koppasoft.com

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for KoppaSoft from gravatar.com KoppaSoft

Credits

Author: Édouard Mercier

License

AGPL-3.0-or-later

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Picteus

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

picteus_ws_client-0.20.0.tar.gz (107.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

picteus_ws_client-0.20.0-py3-none-any.whl (204.1 kB view details)

Uploaded Python 3

File details

Details for the file picteus_ws_client-0.20.0.tar.gz.

File metadata

  • Download URL: picteus_ws_client-0.20.0.tar.gz
  • Upload date:
  • Size: 107.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for picteus_ws_client-0.20.0.tar.gz
Algorithm Hash digest
SHA256 5b94192a106cc189c25cd51755db702e05415d61de53f1eb44c7880647d5ba95
MD5 dd02c1cf1c749aa84556e21dc182ae15
BLAKE2b-256 6f1646ffcaa93ddd06458b1b2a516925289c7da875234ab8b6e6a1318772cb5f

See more details on using hashes here.

File details

Details for the file picteus_ws_client-0.20.0-py3-none-any.whl.

File metadata

File hashes

Hashes for picteus_ws_client-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2e94727927298af0ac567116aecfb227b7be77707c3b1f95934cdcb6ef2a48c7
MD5 350aa47a8f5ec65e33cb90fc6c8f356b
BLAKE2b-256 3f3d92c2dd8bdad73c8362cdc07600626e88c7a4430ea208f48fd95311a50f4a

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.20.0 This release

2 files

0.19.0

2 files

0.18.0

2 files

0.17.1

2 files

0.17.0

2 files

0.16.0

2 files

0.15.0

2 files

0.14.1

2 files

0.14.0

2 files

0.13.0

2 files

0.12.0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page