trevineju / quedapi

openapi-client

API to access the gazettes from all Brazilian cities

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

• API version: 0.17.1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

Requirements.

Python 3.7+

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 quedapi

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 quedapi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import quedapi
from quedapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://queridodiario.ok.org.br/api
# See configuration.py for a list of all supported configuration parameters.
configuration = quedapi.Configuration(
    host = "https://queridodiario.ok.org.br/api"
)



# Enter a context with an instance of the API client
with quedapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quedapi.DefaultApi(api_client)
    theme = 'theme_example' # str | Theme that can be used to search in gazettes by theme.

    try:
        # Get All Available Entities Of A Theme
        api_response = api_instance.get_all_available_entities_of_a_theme_gazettes_by_theme_entities_theme_get(theme)
        print("The response of DefaultApi->get_all_available_entities_of_a_theme_gazettes_by_theme_entities_theme_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->get_all_available_entities_of_a_theme_gazettes_by_theme_entities_theme_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://queridodiario.ok.org.br/api

Class	Method	HTTP request	Description
DefaultApi	get_all_available_entities_of_a_theme_gazettes_by_theme_entities_theme_get	GET /gazettes/by_theme/entities/{theme}	Get All Available Entities Of A Theme
DefaultApi	get_all_available_subthemes_of_a_theme_gazettes_by_theme_subthemes_theme_get	GET /gazettes/by_theme/subthemes/{theme}	Get All Available Subthemes Of A Theme
DefaultApi	get_all_available_themes_gazettes_by_theme_themes_get	GET /gazettes/by_theme/themes/	Get All Available Themes
DefaultApi	get_city_by_ibgeid_cities_territory_id_get	GET /cities/{territory_id}	Get City By Ibge Id
DefaultApi	get_company_info_by_cnpj_number_company_info_cnpj_get	GET /company/info/{cnpj}	Get Company Info By Cnpj Number
DefaultApi	get_company_partners_infos_by_cnpj_number_company_partners_cnpj_get	GET /company/partners/{cnpj}	Get Company Partners Infos By Cnpj Number
DefaultApi	search_for_cities_by_name_cities_get	GET /cities	Search For Cities By Name.
DefaultApi	search_for_content_in_gazette_excerpts_associated_with_a_theme_gazettes_by_theme_theme_get	GET /gazettes/by_theme/{theme}	Search For Content In Gazette Excerpts Associated With A Theme
DefaultApi	search_for_content_in_gazettes_gazettes_get	GET /gazettes	Search For Content In Gazettes
DefaultApi	send_a_suggestion_suggestions_post	POST /suggestions	Send A Suggestion

Documentation For Models

• CitiesSearchResponse
• City
• CityLevel
• CitySearchResponse
• Company
• CompanySearchResponse
• CreateSuggestionBody
• CreatedSuggestionResponse
• EntitiesSearchResponse
• Entity
• GazetteItem
• GazetteSearchResponse
• HTTPExceptionMessage
• HTTPValidationError
• Partner
• PartnersSearchResponse
• SortBy
• SubthemesSearchResponse
• ThemedExcerptItem
• ThemedExcerptSearchResponse
• ThemesSearchResponse
• ValidationError

Documentation For Authorization

Endpoints do not require authorization.

Author