loci-client

The Loci Notes server API.

The Loci Notes server is a FastAPI server that provides a RESTful API for interacting with the Loci Notes system. The server is designed to be used by the Loci Notes web UI, VS Code extension, Loci Notes CLI, and any other clients that may be developed in the future.

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

• API version: 0.20240917.154332
• Package version: 0.20240917.154428
• Generator version: 7.8.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://loci-notes.gitlab.io/

Requirements.

Python 3.7+

Installation & Usage

pip install

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

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

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

Then import the package:

import loci_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 loci_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import loci_client
from loci_client.rest import ApiException
from pprint import pprint

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

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with loci_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = loci_client.DefaultApi(api_client)
    api_key_in = loci_client.ApiKeyIn() # ApiKeyIn | 

    try:
        # Create Api Key
        api_response = api_instance.create_api_key(api_key_in)
        print("The response of DefaultApi->create_api_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->create_api_key: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• ApiKeyIn
• ApiKeyOut
• ApiKeySortEnum
• ApiKeysOut
• ArtifactExport
• ArtifactIn
• ArtifactNote
• ArtifactNoteExport
• ArtifactNoteIn
• ArtifactNoteTypeEnum
• ArtifactNoteUpdateIn
• ArtifactOut
• ArtifactPriorityEnum
• ArtifactSortEnum
• ArtifactTypeEnum
• ArtifactsOut
• HTTPValidationError
• Message
• NewPassword
• OrderByEnum
• ProjectAccessUser
• ProjectExport
• ProjectIn
• ProjectOut
• ProjectSortEnum
• ProjectsOut
• StatusOut
• Token
• UpdatePassword
• UserCreate
• UserCreateOpen
• UserFullOut
• UserOut
• UserUpdate
• UserUpdateMe
• UsersOut
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2PasswordBearer

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

Author

thetwitchy@thetwitchy.com