| Name | omie-py JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | None |
| Summary | Client não oficial da Omie API em Python |
| upload_time | 2024-10-18 19:32:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
api
client
omie
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Documentação do Integrador Omie
## Dependencias
A única dependencia necessária é a biblioteca [zeep](https://docs.python-zeep.org/en/master/index.html), que é usada para criar os clientes SOAP.
## Autenticação
Para autenticar na API do Omie, você precisa fornecer uma `app_key` e um (`app_secret`). Esse dados são obtidos no site da [omie](https://developer.omie.com.br/).
```python
import os
from omie_py.client import OmieClient
key = os.getenv('OMIE_APP_KEY')
secret = os.getenv('OMIE_APP_SECRET')
client = OmieClient(key, secret)
```
## Usar métodos das API
A Omie disponibiliza várias APIs e o cliente recebe uma chamada e verifica em qual API o método está disponível e executa a chamada. O mesmo vale para os tipos disponibilizados na API.
Para verificar os métodos e tipos disponiveis o [site da API](https://developer.omie.com.br/service-list/) deve ser usado.
Os tipos oferecem validação de campos e tipos.
Exemplo para listar departamentos.
```python
departamento_listar_request = client.get_type('departamento_listar_request')
response_pages = client.execute_call("ListarDepartamentos", departamento_listar_request(**{
"pagina": 1,
"registros_por_pagina": 20,
}), True)
for response in response_pages:
print(response)
```
### Métodos principais do cliente
- `execute_call(method_name: str, params: dict, is_paginated: bool = False)`: Executa uma chamada à API.
- `get_type(type_name)`: Obtém um tipo específico para ser usado nas requisições.
### Classe PaginatedResponse
Quando o `is_paginated` é passado como `True` para o método execute_call, o retorno é um `Iterable` que faz as chamadas subsequentes para o método.
### Rate limit
A API atualmente limite a 4 req/s e o projeto não gerencia isso.
[Mais informações](https://ajuda.omie.com.br/pt-BR/articles/8112984-limites-de-consumo-da-api-do-omie).
Raw data
{
"_id": null,
"home_page": null,
"name": "omie-py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "api, client, omie, python",
"author": null,
"author_email": "Murillo Bianconi <murillo.bianconi@buser.com.br>",
"download_url": "https://files.pythonhosted.org/packages/80/ca/9070f3e14af544d5584a5765919970d2358e63eb8b9a5d9f5ec59c1a86fb/omie_py-0.0.0.tar.gz",
"platform": null,
"description": "# Documenta\u00e7\u00e3o do Integrador Omie\n\n## Dependencias\nA \u00fanica dependencia necess\u00e1ria \u00e9 a biblioteca [zeep](https://docs.python-zeep.org/en/master/index.html), que \u00e9 usada para criar os clientes SOAP. \n\n## Autentica\u00e7\u00e3o\n\nPara autenticar na API do Omie, voc\u00ea precisa fornecer uma `app_key` e um (`app_secret`). Esse dados s\u00e3o obtidos no site da [omie](https://developer.omie.com.br/).\n\n```python\nimport os\n\nfrom omie_py.client import OmieClient\n\nkey = os.getenv('OMIE_APP_KEY')\nsecret = os.getenv('OMIE_APP_SECRET')\nclient = OmieClient(key, secret)\n```\n\n## Usar m\u00e9todos das API\n\nA Omie disponibiliza v\u00e1rias APIs e o cliente recebe uma chamada e verifica em qual API o m\u00e9todo est\u00e1 dispon\u00edvel e executa a chamada. O mesmo vale para os tipos disponibilizados na API.\n\nPara verificar os m\u00e9todos e tipos disponiveis o [site da API](https://developer.omie.com.br/service-list/) deve ser usado.\n\nOs tipos oferecem valida\u00e7\u00e3o de campos e tipos.\n\nExemplo para listar departamentos.\n\n```python\ndepartamento_listar_request = client.get_type('departamento_listar_request')\n\nresponse_pages = client.execute_call(\"ListarDepartamentos\", departamento_listar_request(**{\n \"pagina\": 1,\n \"registros_por_pagina\": 20,\n}), True)\n\nfor response in response_pages:\n print(response)\n```\n\n### M\u00e9todos principais do cliente\n\n- `execute_call(method_name: str, params: dict, is_paginated: bool = False)`: Executa uma chamada \u00e0 API.\n- `get_type(type_name)`: Obt\u00e9m um tipo espec\u00edfico para ser usado nas requisi\u00e7\u00f5es.\n\n### Classe PaginatedResponse\n\nQuando o `is_paginated` \u00e9 passado como `True` para o m\u00e9todo execute_call, o retorno \u00e9 um `Iterable` que faz as chamadas subsequentes para o m\u00e9todo.\n\n### Rate limit\nA API atualmente limite a 4 req/s e o projeto n\u00e3o gerencia isso.\n\n[Mais informa\u00e7\u00f5es](https://ajuda.omie.com.br/pt-BR/articles/8112984-limites-de-consumo-da-api-do-omie).",
"bugtrack_url": null,
"license": null,
"summary": "Client n\u00e3o oficial da Omie API em Python",
"version": "0.0.0",
"project_urls": {
"homepage": "https://github.com/buserbrasil/omie-py",
"repository": "https://github.com/buserbrasil/omie-py"
},
"split_keywords": [
"api",
" client",
" omie",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bb46b4833de726a1d5e80534f1bf6ee39f5a2dec794bcf59401fd024da5b13b7",
"md5": "8dd76e665b763064f48adc64329d3ad5",
"sha256": "841dd01a76053c5caa528e2bc5545e3cc6b0f2d609c8d8f793c5accfc5b75f6e"
},
"downloads": -1,
"filename": "omie_py-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8dd76e665b763064f48adc64329d3ad5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 4472,
"upload_time": "2024-10-18T19:32:15",
"upload_time_iso_8601": "2024-10-18T19:32:15.440644Z",
"url": "https://files.pythonhosted.org/packages/bb/46/b4833de726a1d5e80534f1bf6ee39f5a2dec794bcf59401fd024da5b13b7/omie_py-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "80ca9070f3e14af544d5584a5765919970d2358e63eb8b9a5d9f5ec59c1a86fb",
"md5": "4fc26a3e9587e26d610a37b1b4b7039d",
"sha256": "3be394bdd859a0e13ef96a21a45fc941b808be47a69e22d4f8adeeb2d46068fb"
},
"downloads": -1,
"filename": "omie_py-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4fc26a3e9587e26d610a37b1b4b7039d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 18426,
"upload_time": "2024-10-18T19:32:16",
"upload_time_iso_8601": "2024-10-18T19:32:16.751646Z",
"url": "https://files.pythonhosted.org/packages/80/ca/9070f3e14af544d5584a5765919970d2358e63eb8b9a5d9f5ec59c1a86fb/omie_py-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 19:32:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "buserbrasil",
"github_project": "omie-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "omie-py"
}
