Skip to main content

this is my package description well under the limit

Project description

Getting Started with Swagger Petstore - OpenAPI 3.0

Introduction

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at https://swagger.io. In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

Find out more about Swagger: https://swagger.io

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install cinda-package-tyner==1.0.5

You can also view the package at: https://pypi.python.org/pypi/cinda-package-tyner/1.0.5

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT", "GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
petstore_auth_credentials PetstoreAuthCredentials The credential object for OAuth 2 Implicit Grant
api_key_credentials ApiKeyCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from swaggerpetstoreopenapi30.configuration import Environment
from swaggerpetstoreopenapi30.http.auth.api_key import ApiKeyCredentials
from swaggerpetstoreopenapi30.http.auth.petstore_auth import PetstoreAuthCredentials
from swaggerpetstoreopenapi30.logging.configuration.api_logging_configuration import LoggingConfiguration
from swaggerpetstoreopenapi30.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from swaggerpetstoreopenapi30.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from swaggerpetstoreopenapi30.models.oauth_scope_petstore_auth import OauthScopePetstoreAuth
from swaggerpetstoreopenapi30.swaggerpetstoreopenapi_30_client import Swaggerpetstoreopenapi30Client

client = Swaggerpetstoreopenapi30Client(
    petstore_auth_credentials=PetstoreAuthCredentials(
        oauth_client_id='OAuthClientId',
        oauth_redirect_uri='OAuthRedirectUri',
        oauth_scopes=[
            OauthScopePetstoreAuth.WRITEPETS,
            OauthScopePetstoreAuth.READPETS
        ]
    ),
    api_key_credentials=ApiKeyCredentials(
        api_key='api_key'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from swaggerpetstoreopenapi30.swaggerpetstoreopenapi_30_client import Swaggerpetstoreopenapi30Client

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = Swaggerpetstoreopenapi30Client.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
PRODUCTION Default

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Project details


Download files

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

Source Distribution

cinda_package_tyner-1.0.5.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

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

cinda_package_tyner-1.0.5-py3-none-any.whl (49.6 kB view details)

Uploaded Python 3

File details

Details for the file cinda_package_tyner-1.0.5.tar.gz.

File metadata

  • Download URL: cinda_package_tyner-1.0.5.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for cinda_package_tyner-1.0.5.tar.gz
Algorithm Hash digest
SHA256 6114324f5ae7db8438639813b50975f77bbbb2d23e5f5f8d95be4c7bb7a0a9e6
MD5 e3d7f1d5240b41c2bef028b8a34aa2a9
BLAKE2b-256 59fc07f622819ad2e07c68ad2433bc37fb27f317b921a7dec050fabd19069e02

See more details on using hashes here.

File details

Details for the file cinda_package_tyner-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for cinda_package_tyner-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 896fe615043b9bf3d870bc010fda731009ba68346e5c1dd0ab3a66933fa0ecfb
MD5 038606176734c6a69680c5c4c8a32b06
BLAKE2b-256 f90657962e5aad8f455decd90d7050fd2b338854cf7aed0a47759f5a976206ce

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