freeradical-client 1.0.0

FreeRadical CMS API

freeradical-client

Headless CMS API for FreeRadical

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

• API version: 0.9.0
• Package version: 1.0.0
• Generator version: 7.18.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 freeradical_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 freeradical_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import freeradical_client
from freeradical_client.rest import ApiException
from pprint import pprint

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

# 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 Bearer authorization (JWT): bearerAuth
configuration = freeradical_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


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

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DefaultApi	analytics_summary_get	GET /analytics/summary	Get analytics summary
DefaultApi	auth_login_post	POST /auth/login	Authenticate user
DefaultApi	pages_get	GET /pages	List pages
DefaultApi	pages_post	POST /pages	Create a page
DefaultApi	pages_uuid_get	GET /pages/{uuid}	Get page by UUID

Documentation For Models

• AnalyticsSummaryGet200Response
• LoginRequest
• LoginResponse
• Page
• User

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author