estela-client

estela API Swagger Specification

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

API version: v1
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.6

Installation & Usage

pip install

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

pip install git+https://github.com/bitmakerla/estela-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/bitmakerla/estela-python-client.git)

Then import the package:

import estela_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 estela_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import estela_client
from pprint import pprint
from estela_client.api import auth_api
from estela_client.model.auth_token import AuthToken
from estela_client.model.change_password import ChangePassword
from estela_client.model.inline_response200 import InlineResponse200
from estela_client.model.inline_response401 import InlineResponse401
from estela_client.model.reset_password_confirm import ResetPasswordConfirm
from estela_client.model.reset_password_request import ResetPasswordRequest
from estela_client.model.token import Token
from estela_client.model.user import User
from estela_client.model.user_profile import UserProfile
# Defining the host is optional and defaults to http://127.0.0.1:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = estela_client.Configuration(
    host = "http://127.0.0.1:8000"
)

# 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 HTTP basic authorization: Basic
configuration = estela_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)


# Enter a context with an instance of the API client
with estela_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = auth_api.AuthApi(api_client)
    data = ChangePassword(
        new_password="new_password_example",
        confirm_new_password="confirm_new_password_example",
        old_password="old_password_example",
    ) # ChangePassword | 

    try:
        api_response = api_instance.api_account_change_password_change(data)
        pprint(api_response)
    except estela_client.ApiException as e:
        print("Exception when calling AuthApi->api_account_change_password_change: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request
AuthApi	api_account_change_password_change	PATCH /api/account/changePassword/change
AuthApi	api_account_reset_password_confirm	PATCH /api/account/resetPassword/confirm
AuthApi	api_account_reset_password_request	POST /api/account/resetPassword/request
AuthApi	api_account_reset_password_validate	GET /api/account/resetPassword/validate
AuthApi	api_auth_activate	GET /api/auth/activate
AuthApi	api_auth_login	POST /api/auth/login
AuthApi	api_auth_profile_create	POST /api/auth/profile
AuthApi	api_auth_profile_delete	DELETE /api/auth/profile/{username}
AuthApi	api_auth_profile_list	GET /api/auth/profile
AuthApi	api_auth_profile_partial_update	PATCH /api/auth/profile/{username}
AuthApi	api_auth_profile_read	GET /api/auth/profile/{username}
AuthApi	api_auth_profile_update	PUT /api/auth/profile/{username}
AuthApi	api_auth_register	POST /api/auth/register
DeploysApi	api_projects_deploys_create	POST /api/projects/{pid}/deploys
DeploysApi	api_projects_deploys_delete	DELETE /api/projects/{pid}/deploys/{did}
DeploysApi	api_projects_deploys_list	GET /api/projects/{pid}/deploys
DeploysApi	api_projects_deploys_partial_update	PATCH /api/projects/{pid}/deploys/{did}
DeploysApi	api_projects_deploys_read	GET /api/projects/{pid}/deploys/{did}
DeploysApi	api_projects_deploys_update	PUT /api/projects/{pid}/deploys/{did}
ProjectsApi	api_projects_create	POST /api/projects
ProjectsApi	api_projects_cronjobs	GET /api/projects/{pid}/cronjobs
ProjectsApi	api_projects_current_usage	GET /api/projects/{pid}/current_usage
ProjectsApi	api_projects_delete	DELETE /api/projects/{pid}
ProjectsApi	api_projects_jobs	GET /api/projects/{pid}/jobs
ProjectsApi	api_projects_list	GET /api/projects
ProjectsApi	api_projects_partial_update	PATCH /api/projects/{pid}
ProjectsApi	api_projects_read	GET /api/projects/{pid}
ProjectsApi	api_projects_update	PUT /api/projects/{pid}
ProjectsApi	api_projects_usage	GET /api/projects/{pid}/usage
SpiderCronjobsApi	api_projects_spiders_cronjobs_create	POST /api/projects/{pid}/spiders/{sid}/cronjobs
SpiderCronjobsApi	api_projects_spiders_cronjobs_delete	DELETE /api/projects/{pid}/spiders/{sid}/cronjobs/{cjid}
SpiderCronjobsApi	api_projects_spiders_cronjobs_list	GET /api/projects/{pid}/spiders/{sid}/cronjobs
SpiderCronjobsApi	api_projects_spiders_cronjobs_partial_update	PATCH /api/projects/{pid}/spiders/{sid}/cronjobs/{cjid}
SpiderCronjobsApi	api_projects_spiders_cronjobs_read	GET /api/projects/{pid}/spiders/{sid}/cronjobs/{cjid}
SpiderCronjobsApi	api_projects_spiders_cronjobs_run_once	GET /api/projects/{pid}/spiders/{sid}/cronjobs/{cjid}/run_once
SpiderCronjobsApi	api_projects_spiders_cronjobs_update	PUT /api/projects/{pid}/spiders/{sid}/cronjobs/{cjid}
SpiderJobsApi	api_projects_spiders_jobs_create	POST /api/projects/{pid}/spiders/{sid}/jobs
SpiderJobsApi	api_projects_spiders_jobs_data_delete	POST /api/projects/{pid}/spiders/{sid}/jobs/{jid}/data/delete
SpiderJobsApi	api_projects_spiders_jobs_data_list	GET /api/projects/{pid}/spiders/{sid}/jobs/{jid}/data
SpiderJobsApi	api_projects_spiders_jobs_list	GET /api/projects/{pid}/spiders/{sid}/jobs
SpiderJobsApi	api_projects_spiders_jobs_partial_update	PATCH /api/projects/{pid}/spiders/{sid}/jobs/{jid}
SpiderJobsApi	api_projects_spiders_jobs_read	GET /api/projects/{pid}/spiders/{sid}/jobs/{jid}
SpiderJobsApi	api_projects_spiders_jobs_update	PUT /api/projects/{pid}/spiders/{sid}/jobs/{jid}
SpidersApi	api_projects_spiders_list	GET /api/projects/{pid}/spiders
SpidersApi	api_projects_spiders_partial_update	PATCH /api/projects/{pid}/spiders/{sid}
SpidersApi	api_projects_spiders_read	GET /api/projects/{pid}/spiders/{sid}
SpidersApi	api_projects_spiders_update	PUT /api/projects/{pid}/spiders/{sid}

Documentation For Models

Documentation For Authorization

Basic

Type: HTTP basic authentication

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in estela_client.apis and estela_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

from estela_client.api.default_api import DefaultApi
from estela_client.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import estela_client
from estela_client.apis import *
from estela_client.models import *

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
.openapi-generator		.openapi-generator
docs		docs
estela_client		estela_client
test		test
.gitignore		.gitignore
.gitlab-ci.yml		.gitlab-ci.yml
.openapi-generator-ignore		.openapi-generator-ignore
.travis.yml		.travis.yml
Dockerfile		Dockerfile
Makefile		Makefile
README.md		README.md
git_push.sh		git_push.sh
requirements.txt		requirements.txt
setup.cfg		setup.cfg
setup.py		setup.py
test-requirements.txt		test-requirements.txt
tox.ini		tox.ini

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

estela-client

Requirements.

Installation & Usage

pip install

Setuptools

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

Basic

Author

Notes for Large OpenAPI documents

About

Releases

Packages

Languages

bitmakerla/estela-python-client

Folders and files

Latest commit

History

Repository files navigation

estela-client

Requirements.

Installation & Usage

pip install

Setuptools

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

Basic

Author

Notes for Large OpenAPI documents

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages