Scorb API
Use scorb functionalities in your python application.
Instalation
pip install scorb-api
Configuration
Environment variables
To use scorb-api, you need to set two environment variables:
# ---DOTENV EXAMPLE---
SCORB_USERNAME_API= # Username to authenticate
SCORB_PASSWORD_API= # Password to authenticate
SCORB_BASE_URL=https://scorb.com.br/ # Base path of your api instance
Usage Example
You can use scorb-api in order to read registers on all system tables.
List registers
You can use get methods to list registers of system table. See the following example:
from scorb_api import ScorbApiClient
# Instantiate ScorbApiClient client object
client = ScorbApiClient(company="your-company", app_name="your-app-name")
# Get the endpoint
cenario_endpoint = client.globais().cenario()
calculo_alcance_enpoint = client.entidades_de_cenario().calculo_alcance(
cenario_code="cenario_code"
)
custom_entity_enpoint = client.entidades_customizadas().entidade_customizada(
cenario_code="cenario_code", custom="custom_endpoint_name"
)
custom_table_endpoint = client.tabelas_customizadas().tabela_customizada(
cenario_code="cenario_code", custom="custom_endpoint_name"
)
# Read will return a list of objects from API.
cenarios_data = cenario_endpoint.read()
calculo_alcance_data = calculo_alcance_enpoint.read()
custom_entity_data = custom_entity_enpoint.read()
custom_table_data = custom_table_endpoint.read()
Metadata
Release files for scorb-api 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| scorb_api-0.2.1.tar.gz | 10.0 kB | Without provenance | Details for scorb_api-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| scorb_api-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for scorb_api-0.2.1-py3-none-any.whl |
Total release size: 40.6 kB
Release files / scorb_api-0.2.1.tar.gz
| Download URL | scorb_api-0.2.1.tar.gz |
|---|---|
| Size | 10.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5591c7ac47bd8bf1ffed332b2d52140dd756f9730628ff574c815d064c959483
|
|
BLAKE2b-256 checksum How to use checksums |
0f0f892b79ad480186fbfe285f2a1c14d5a7c3deb68651a3009e5537b444c06d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / scorb_api-0.2.1-py3-none-any.whl
| Download URL | scorb_api-0.2.1-py3-none-any.whl |
|---|---|
| Size | 30.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1b802c99ce2c2ec243752bcf1f046a2d3141d29b7e8fdd927631fdc6d07ee920
|
|
BLAKE2b-256 checksum How to use checksums |
5fe4cff6d027acd5ee82ae68bb188b7f4902dea44c425d342639d6dec8303e1a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for scorb-api 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.