ksapi 1.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
ksapi-1.0.2/PKG-INFO ADDED
@@ -0,0 +1,123 @@
1
+ Metadata-Version: 2.4
2
+ Name: ksapi
3
+ Version: 1.0.2
4
+ Summary: Knowledge Stack API
5
+ Home-page:
6
+ Author: OpenAPI Generator community
7
+ Author-email: OpenAPI Generator Community <team@openapitools.org>
8
+ Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
9
+ Keywords: OpenAPI,OpenAPI-Generator,Knowledge Stack API
10
+ Requires-Python: >=3.9
11
+ Description-Content-Type: text/markdown
12
+ Requires-Dist: urllib3<3.0.0,>=2.1.0
13
+ Requires-Dist: python-dateutil>=2.8.2
14
+ Requires-Dist: pydantic>=2
15
+ Requires-Dist: typing-extensions>=4.7.1
16
+ Dynamic: author
17
+
18
+ # ksapi
19
+ Knowledge Stack backend API for authentication and knowledge management
20
+
21
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
22
+
23
+ - API version: 0.1.0
24
+ - Package version: 1.0.2
25
+ - Generator version: 7.16.0
26
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
27
+
28
+ ## Requirements.
29
+
30
+ Python 3.9+
31
+
32
+ ## Installation & Usage
33
+ ### pip install
34
+
35
+ If the python package is hosted on a repository, you can install directly using:
36
+
37
+ ```sh
38
+ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
39
+ ```
40
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
41
+
42
+ Then import the package:
43
+ ```python
44
+ import ksapi
45
+ ```
46
+
47
+ ### Setuptools
48
+
49
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
50
+
51
+ ```sh
52
+ python setup.py install --user
53
+ ```
54
+ (or `sudo python setup.py install` to install the package for all users)
55
+
56
+ Then import the package:
57
+ ```python
58
+ import ksapi
59
+ ```
60
+
61
+ ### Tests
62
+
63
+ Execute `pytest` to run the tests.
64
+
65
+ ## Getting Started
66
+
67
+ Please follow the [installation procedure](#installation--usage) and then run the following:
68
+
69
+ ```python
70
+
71
+ import ksapi
72
+ from ksapi.rest import ApiException
73
+ from pprint import pprint
74
+
75
+ # Defining the host is optional and defaults to http://localhost:8000
76
+ # See configuration.py for a list of all supported configuration parameters.
77
+ configuration = ksapi.Configuration(
78
+ host = "http://localhost:8000"
79
+ )
80
+
81
+
82
+
83
+ # Enter a context with an instance of the API client
84
+ with ksapi.ApiClient(configuration) as api_client:
85
+ # Create an instance of the API class
86
+ api_instance = ksapi.DefaultApi(api_client)
87
+
88
+ try:
89
+ # Health Check
90
+ api_response = api_instance.health_check_healthz_get()
91
+ print("The response of DefaultApi->health_check_healthz_get:\n")
92
+ pprint(api_response)
93
+ except ApiException as e:
94
+ print("Exception when calling DefaultApi->health_check_healthz_get: %s\n" % e)
95
+
96
+ ```
97
+
98
+ ## Documentation for API Endpoints
99
+
100
+ All URIs are relative to *http://localhost:8000*
101
+
102
+ Class | Method | HTTP request | Description
103
+ ------------ | ------------- | ------------- | -------------
104
+ *DefaultApi* | [**health_check_healthz_get**](docs/DefaultApi.md#health_check_healthz_get) | **GET** /healthz | Health Check
105
+ *DefaultApi* | [**root_get**](docs/DefaultApi.md#root_get) | **GET** / | Root
106
+
107
+
108
+ ## Documentation For Models
109
+
110
+ - [HealthCheckResponse](docs/HealthCheckResponse.md)
111
+
112
+
113
+ <a id="documentation-for-authorization"></a>
114
+ ## Documentation For Authorization
115
+
116
+ Endpoints do not require authorization.
117
+
118
+
119
+ ## Author
120
+
121
+
122
+
123
+
ksapi-1.0.2/README.md ADDED
@@ -0,0 +1,106 @@
1
+ # ksapi
2
+ Knowledge Stack backend API for authentication and knowledge management
3
+
4
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
5
+
6
+ - API version: 0.1.0
7
+ - Package version: 1.0.2
8
+ - Generator version: 7.16.0
9
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
10
+
11
+ ## Requirements.
12
+
13
+ Python 3.9+
14
+
15
+ ## Installation & Usage
16
+ ### pip install
17
+
18
+ If the python package is hosted on a repository, you can install directly using:
19
+
20
+ ```sh
21
+ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
22
+ ```
23
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
24
+
25
+ Then import the package:
26
+ ```python
27
+ import ksapi
28
+ ```
29
+
30
+ ### Setuptools
31
+
32
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
33
+
34
+ ```sh
35
+ python setup.py install --user
36
+ ```
37
+ (or `sudo python setup.py install` to install the package for all users)
38
+
39
+ Then import the package:
40
+ ```python
41
+ import ksapi
42
+ ```
43
+
44
+ ### Tests
45
+
46
+ Execute `pytest` to run the tests.
47
+
48
+ ## Getting Started
49
+
50
+ Please follow the [installation procedure](#installation--usage) and then run the following:
51
+
52
+ ```python
53
+
54
+ import ksapi
55
+ from ksapi.rest import ApiException
56
+ from pprint import pprint
57
+
58
+ # Defining the host is optional and defaults to http://localhost:8000
59
+ # See configuration.py for a list of all supported configuration parameters.
60
+ configuration = ksapi.Configuration(
61
+ host = "http://localhost:8000"
62
+ )
63
+
64
+
65
+
66
+ # Enter a context with an instance of the API client
67
+ with ksapi.ApiClient(configuration) as api_client:
68
+ # Create an instance of the API class
69
+ api_instance = ksapi.DefaultApi(api_client)
70
+
71
+ try:
72
+ # Health Check
73
+ api_response = api_instance.health_check_healthz_get()
74
+ print("The response of DefaultApi->health_check_healthz_get:\n")
75
+ pprint(api_response)
76
+ except ApiException as e:
77
+ print("Exception when calling DefaultApi->health_check_healthz_get: %s\n" % e)
78
+
79
+ ```
80
+
81
+ ## Documentation for API Endpoints
82
+
83
+ All URIs are relative to *http://localhost:8000*
84
+
85
+ Class | Method | HTTP request | Description
86
+ ------------ | ------------- | ------------- | -------------
87
+ *DefaultApi* | [**health_check_healthz_get**](docs/DefaultApi.md#health_check_healthz_get) | **GET** /healthz | Health Check
88
+ *DefaultApi* | [**root_get**](docs/DefaultApi.md#root_get) | **GET** / | Root
89
+
90
+
91
+ ## Documentation For Models
92
+
93
+ - [HealthCheckResponse](docs/HealthCheckResponse.md)
94
+
95
+
96
+ <a id="documentation-for-authorization"></a>
97
+ ## Documentation For Authorization
98
+
99
+ Endpoints do not require authorization.
100
+
101
+
102
+ ## Author
103
+
104
+
105
+
106
+
@@ -0,0 +1,50 @@
1
+ # coding: utf-8
2
+
3
+ # flake8: noqa
4
+
5
+ """
6
+ Knowledge Stack API
7
+
8
+ Knowledge Stack backend API for authentication and knowledge management
9
+
10
+ The version of the OpenAPI document: 0.1.0
11
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
12
+
13
+ Do not edit the class manually.
14
+ """ # noqa: E501
15
+
16
+
17
+ __version__ = "1.0.2"
18
+
19
+ # Define package exports
20
+ __all__ = [
21
+ "DefaultApi",
22
+ "ApiResponse",
23
+ "ApiClient",
24
+ "Configuration",
25
+ "OpenApiException",
26
+ "ApiTypeError",
27
+ "ApiValueError",
28
+ "ApiKeyError",
29
+ "ApiAttributeError",
30
+ "ApiException",
31
+ "HealthCheckResponse",
32
+ ]
33
+
34
+ # import apis into sdk package
35
+ from ksapi.api.default_api import DefaultApi as DefaultApi
36
+
37
+ # import ApiClient
38
+ from ksapi.api_response import ApiResponse as ApiResponse
39
+ from ksapi.api_client import ApiClient as ApiClient
40
+ from ksapi.configuration import Configuration as Configuration
41
+ from ksapi.exceptions import OpenApiException as OpenApiException
42
+ from ksapi.exceptions import ApiTypeError as ApiTypeError
43
+ from ksapi.exceptions import ApiValueError as ApiValueError
44
+ from ksapi.exceptions import ApiKeyError as ApiKeyError
45
+ from ksapi.exceptions import ApiAttributeError as ApiAttributeError
46
+ from ksapi.exceptions import ApiException as ApiException
47
+
48
+ # import models into sdk package
49
+ from ksapi.models.health_check_response import HealthCheckResponse as HealthCheckResponse
50
+
@@ -0,0 +1,5 @@
1
+ # flake8: noqa
2
+
3
+ # import apis into api package
4
+ from ksapi.api.default_api import DefaultApi
5
+