# seroapi
Muiltidomain static site hosting
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.2.7
- Package version: 0.2.7
- Generator version: 7.7.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
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:
```python
import seroapi
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import seroapi
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import seroapi
from seroapi.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 = seroapi.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with seroapi.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = seroapi.AccountManagementApi(api_client)
login_request = seroapi.LoginRequest() # LoginRequest |
try:
# Login user and receive JWT token.
api_response = api_instance.login(login_request)
print("The response of AccountManagementApi->login:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountManagementApi->login: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountManagementApi* | [**login**](docs/AccountManagementApi.md#login) | **POST** /api/auth/login | Login user and receive JWT token.
*AccountManagementApi* | [**registration**](docs/AccountManagementApi.md#registration) | **POST** /api/auth/registration | Register new user for sero server.
*ActionsApi* | [**disable_site**](docs/ActionsApi.md#disable_site) | **PATCH** /api/site/disable | Disables a specific site identified by the `x-subdomain` header.
*ActionsApi* | [**download_site**](docs/ActionsApi.md#download_site) | **GET** /api/site | Download site of the specified subdomain.
*ActionsApi* | [**enable_site**](docs/ActionsApi.md#enable_site) | **PATCH** /api/site/enable | Enables a specific site identified by the `x-subdomain` header.
*ActionsApi* | [**teardown_site**](docs/ActionsApi.md#teardown_site) | **DELETE** /api/site | Removes a specific site identified by the `x-subdomain` header.
*ActionsApi* | [**upload_site**](docs/ActionsApi.md#upload_site) | **POST** /api/site | Uploads site for a specified subdomain.
*OriginsManagementAndDynamicAccessControlApi* | [**create_origin**](docs/OriginsManagementAndDynamicAccessControlApi.md#create_origin) | **POST** /api/origin | Adds a new origin to a specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.
*OriginsManagementAndDynamicAccessControlApi* | [**delete_all_origins**](docs/OriginsManagementAndDynamicAccessControlApi.md#delete_all_origins) | **DELETE** /api/origin | Delete all origins for specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.
*OriginsManagementAndDynamicAccessControlApi* | [**delete_origin_by_id**](docs/OriginsManagementAndDynamicAccessControlApi.md#delete_origin_by_id) | **DELETE** /api/origin/{id} | Delete origin by id for specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.
*OriginsManagementAndDynamicAccessControlApi* | [**get_all_origins**](docs/OriginsManagementAndDynamicAccessControlApi.md#get_all_origins) | **GET** /api/origin | List all origins for specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.
*OriginsManagementAndDynamicAccessControlApi* | [**get_origin_by_id**](docs/OriginsManagementAndDynamicAccessControlApi.md#get_origin_by_id) | **GET** /api/origin/{id} | Get specified origin [by id] for specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.
## Documentation For Models
- [AddOriginRequest](docs/AddOriginRequest.md)
- [AddOriginResponse](docs/AddOriginResponse.md)
- [Details](docs/Details.md)
- [GetOriginResponse](docs/GetOriginResponse.md)
- [ListOriginsResponse](docs/ListOriginsResponse.md)
- [LoginRequest](docs/LoginRequest.md)
- [LoginResponse](docs/LoginResponse.md)
- [OriginModel](docs/OriginModel.md)
- [RegistrationRequest](docs/RegistrationRequest.md)
- [RegistrationResponse](docs/RegistrationResponse.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="Bearer-JWT"></a>
### Bearer-JWT
- **Type**: Bearer authentication (JWT)
## Author
clowzed.work@gmail.com
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "seroapi",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, sero",
"author": "clowzed",
"author_email": "clowzed.work@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8c/3c/daea833e1fa94bc08ecfa12b537349f9f79639dc4174996932cd94d02abd/seroapi-0.2.7.tar.gz",
"platform": null,
"description": "# seroapi\nMuiltidomain static site hosting\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.2.7\n- Package version: 0.2.7\n- Generator version: 7.7.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport seroapi\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport seroapi\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport seroapi\nfrom seroapi.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = seroapi.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith seroapi.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = seroapi.AccountManagementApi(api_client)\n login_request = seroapi.LoginRequest() # LoginRequest | \n\n try:\n # Login user and receive JWT token.\n api_response = api_instance.login(login_request)\n print(\"The response of AccountManagementApi->login:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling AccountManagementApi->login: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AccountManagementApi* | [**login**](docs/AccountManagementApi.md#login) | **POST** /api/auth/login | Login user and receive JWT token.\n*AccountManagementApi* | [**registration**](docs/AccountManagementApi.md#registration) | **POST** /api/auth/registration | Register new user for sero server.\n*ActionsApi* | [**disable_site**](docs/ActionsApi.md#disable_site) | **PATCH** /api/site/disable | Disables a specific site identified by the `x-subdomain` header.\n*ActionsApi* | [**download_site**](docs/ActionsApi.md#download_site) | **GET** /api/site | Download site of the specified subdomain.\n*ActionsApi* | [**enable_site**](docs/ActionsApi.md#enable_site) | **PATCH** /api/site/enable | Enables a specific site identified by the `x-subdomain` header.\n*ActionsApi* | [**teardown_site**](docs/ActionsApi.md#teardown_site) | **DELETE** /api/site | Removes a specific site identified by the `x-subdomain` header.\n*ActionsApi* | [**upload_site**](docs/ActionsApi.md#upload_site) | **POST** /api/site | Uploads site for a specified subdomain.\n*OriginsManagementAndDynamicAccessControlApi* | [**create_origin**](docs/OriginsManagementAndDynamicAccessControlApi.md#create_origin) | **POST** /api/origin | Adds a new origin to a specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.\n*OriginsManagementAndDynamicAccessControlApi* | [**delete_all_origins**](docs/OriginsManagementAndDynamicAccessControlApi.md#delete_all_origins) | **DELETE** /api/origin | Delete all origins for specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.\n*OriginsManagementAndDynamicAccessControlApi* | [**delete_origin_by_id**](docs/OriginsManagementAndDynamicAccessControlApi.md#delete_origin_by_id) | **DELETE** /api/origin/{id} | Delete origin by id for specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.\n*OriginsManagementAndDynamicAccessControlApi* | [**get_all_origins**](docs/OriginsManagementAndDynamicAccessControlApi.md#get_all_origins) | **GET** /api/origin | List all origins for specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.\n*OriginsManagementAndDynamicAccessControlApi* | [**get_origin_by_id**](docs/OriginsManagementAndDynamicAccessControlApi.md#get_origin_by_id) | **GET** /api/origin/{id} | Get specified origin [by id] for specified subdomain for dynamic CORS (Cross-Origin Resource Sharing) management.\n\n\n## Documentation For Models\n\n - [AddOriginRequest](docs/AddOriginRequest.md)\n - [AddOriginResponse](docs/AddOriginResponse.md)\n - [Details](docs/Details.md)\n - [GetOriginResponse](docs/GetOriginResponse.md)\n - [ListOriginsResponse](docs/ListOriginsResponse.md)\n - [LoginRequest](docs/LoginRequest.md)\n - [LoginResponse](docs/LoginResponse.md)\n - [OriginModel](docs/OriginModel.md)\n - [RegistrationRequest](docs/RegistrationRequest.md)\n - [RegistrationResponse](docs/RegistrationResponse.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"Bearer-JWT\"></a>\n### Bearer-JWT\n\n- **Type**: Bearer authentication (JWT)\n\n\n## Author\n\nclowzed.work@gmail.com\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "sero",
"version": "0.2.7",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" sero"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fee9079642d026959d45ca1ff98091d6091082b2d72172189dc537377e1c1163",
"md5": "bacca7838dbe15bfa35149e56058b055",
"sha256": "18490e10e8ca08e802f8928308e0e32a2c22fe9f6313581fc1ef83c43e76f653"
},
"downloads": -1,
"filename": "seroapi-0.2.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bacca7838dbe15bfa35149e56058b055",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 41145,
"upload_time": "2024-08-06T01:12:03",
"upload_time_iso_8601": "2024-08-06T01:12:03.168261Z",
"url": "https://files.pythonhosted.org/packages/fe/e9/079642d026959d45ca1ff98091d6091082b2d72172189dc537377e1c1163/seroapi-0.2.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c3cdaea833e1fa94bc08ecfa12b537349f9f79639dc4174996932cd94d02abd",
"md5": "84a7deabad150b8d4a71a284f505868e",
"sha256": "ac8cdcb44e9fc0460f798c86bad950778684cb012c550201be6c7c5bf7a6a8f1"
},
"downloads": -1,
"filename": "seroapi-0.2.7.tar.gz",
"has_sig": false,
"md5_digest": "84a7deabad150b8d4a71a284f505868e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 25621,
"upload_time": "2024-08-06T01:12:04",
"upload_time_iso_8601": "2024-08-06T01:12:04.686302Z",
"url": "https://files.pythonhosted.org/packages/8c/3c/daea833e1fa94bc08ecfa12b537349f9f79639dc4174996932cd94d02abd/seroapi-0.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 01:12:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "seroapi"
}
JSON
