Skip to main content

Knowledge Stack API

Project description

ksapi

Knowledge Stack backend API for authentication and knowledge management

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

  • API version: 0.1.0
  • Package version: 1.0.3
  • Generator version: 7.16.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

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/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 ksapi

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 ksapi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ksapi
from ksapi.rest import ApiException
from pprint import pprint

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



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

    try:
        # Health Check
        api_response = api_instance.health_check_healthz_get()
        print("The response of DefaultApi->health_check_healthz_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->health_check_healthz_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Class Method HTTP request Description
DefaultApi health_check_healthz_get GET /healthz Health Check
DefaultApi root_get GET / Root

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

ksapi-1.0.3.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

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

ksapi-1.0.3-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file ksapi-1.0.3.tar.gz.

File metadata

  • Download URL: ksapi-1.0.3.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ksapi-1.0.3.tar.gz
Algorithm Hash digest
SHA256 610a19b496cd945ca8be3c6d7f53dfcd6b89e41e4eb77b8b4db44c50a86d3beb
MD5 92788e22f74a384c54a8dc7379b9c7f3
BLAKE2b-256 50b9a1ed16f5b5260971d7824742e85b85b32c46c15e691a46bad8497818608c

See more details on using hashes here.

File details

Details for the file ksapi-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: ksapi-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ksapi-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ae39aecc11b4a49031b02da5c00e242de5eeb961cfa65935fe65167ced3f6de5
MD5 3ca7821e4809eb9c74845be91dfe4412
BLAKE2b-256 4d79e7ea6a26de608248b613e3aea7bfd1910a45e427c2eb2c5c5686aba1c88c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page