# Api Omie SDK
<em>*Aviso: Este projeto não tem ligação oficial com a Omie</em>
> SDK Multi Linguagem para integrar com a Omie API
[](https://MikalROn.github.io/ApiOmieSDK/)
## Documentação Oficial da Omie
Recomendamos sempre consultar a documentação oficial da Omie para detalhes completos das funções disponíveis:
[Omie API - Documentação Oficial](https://developer.omie.com.br/service-list/)
## Instalação (Python)
Para instalar o pacote da Omie via `pip`, use o seguinte comando:
```bash
pip install api-omie
```
## Como usar
Veja abaixo como fazer uma chamada básica para listar produtos usando a Omie API.
### Exemplo de uso básico
```python
from omieapi import Omie
omie_app = Omie('sua_app_key', 'seu_app_secret')
response = omie_app.listar_produtos(pagina=1)
print(response)
```
Os metodos se encontram neste formato `nome_da_chamada(**argumentos)`
## Usando Sessões para Melhor Desempenho
Se você for fazer várias requisições à API, é altamente recomendado usar uma sessão para reutilizar a conexão e reduzir o overhead de abrir novas conexões a cada chamada. Veja como abrir e fechar uma sessão:
```python
from omieapi import Omie
omie_app = Omie('sua_app_key', 'seu_app_secret', session=True)
response = omie_app.listar_produtos(pagina=1)
omie_app.fechar_session()
print(response)
```
O SDK também oferece suporte ao uso de gerenciador de contexto para abrir e fechar sessões automaticamente. Todas as chamadas com gerenciador de contexto tem por padrão o uso da sessão.
```python
from omieapi import Omie
omie_app = Omie('sua_app_key', 'seu_app_secret')
with omie_app as r:
response = r.listar_produtos(pagina=1)
print(response)
```
É possível abrir uma sessão utilizando o metodo `Omie.abrir_sessão()`
### Exemplo de uso com `httpx`
```python
from omieapi import Omie
omie_app = Omie('sua_app_key', 'seu_app_secret', use_httpx=True)
response = omie_app.listar_produtos(pagina=1)
print(response)
```
### Ativando Logs para Depuração
```python
from omieapi import Omie
omie_app = Omie('sua_app_key', 'seu_app_secret', log=True)
response = omie_app.listar_produtos(pagina=1)
print(response)
```
## Contribua com este Projeto
Estamos sempre em busca de melhorias! Um dos próximos passos para este SDK é torná-lo realmente multi-linguagem, com suporte a diferentes linguagens de programação. Já existe um script de scraping que extrai os tipos complexos da API, mas ainda precisamos de ajuda para gerar o código de maneira automatizada.
### Como Contribuir
- Clone o repositório
- Crie uma nova branch para suas mudanças
- Envie um pull request
Raw data
{
"_id": null,
"home_page": "https://github.com/MikalROn/ApiOmie-nao-oficial",
"name": "api-omie",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "Omie API, API Omie, Omie integra\u00e7\u00e3o, Omie SDK, SDK para Omie, integra\u00e7\u00e3o Omie, Omie API SDK, omieapi, apiomiesdk, omie sdk, automatiza\u00e7\u00e3o Omie, conex\u00e3o Omie, desenvolvimento Omie, Omie Python, API ERP Omie, Omie integra\u00e7\u00e3o Python, Omie API integra\u00e7\u00e3o, API para Omie, Omie API integra\u00e7\u00e3o",
"author": "Daniel Co\u00ealho",
"author_email": "heromon.9010@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3a/f2/18cf0afb02c4090a483af99a49a40bdeea9dda5759cd70149304b2ccdbc0/api_omie-0.4.6.tar.gz",
"platform": null,
"description": "\n\n# Api Omie SDK\n\n<em>*Aviso: Este projeto n\u00e3o tem liga\u00e7\u00e3o oficial com a Omie</em>\n\n> SDK Multi Linguagem para integrar com a Omie API\n\n\n\n\n\n\n[](https://MikalROn.github.io/ApiOmieSDK/)\n\n\n## Documenta\u00e7\u00e3o Oficial da Omie\n\nRecomendamos sempre consultar a documenta\u00e7\u00e3o oficial da Omie para detalhes completos das fun\u00e7\u00f5es dispon\u00edveis:\n\n[Omie API - Documenta\u00e7\u00e3o Oficial](https://developer.omie.com.br/service-list/)\n\n## Instala\u00e7\u00e3o (Python)\n\nPara instalar o pacote da Omie via `pip`, use o seguinte comando:\n\n```bash\npip install api-omie\n```\n\n## Como usar\n\nVeja abaixo como fazer uma chamada b\u00e1sica para listar produtos usando a Omie API.\n\n### Exemplo de uso b\u00e1sico\n\n```python\nfrom omieapi import Omie\n\nomie_app = Omie('sua_app_key', 'seu_app_secret')\nresponse = omie_app.listar_produtos(pagina=1)\n\nprint(response)\n```\n\nOs metodos se encontram neste formato `nome_da_chamada(**argumentos)`\n\n\n## Usando Sess\u00f5es para Melhor Desempenho\n\nSe voc\u00ea for fazer v\u00e1rias requisi\u00e7\u00f5es \u00e0 API, \u00e9 altamente recomendado usar uma sess\u00e3o para reutilizar a conex\u00e3o e reduzir o overhead de abrir novas conex\u00f5es a cada chamada. Veja como abrir e fechar uma sess\u00e3o:\n\n```python\nfrom omieapi import Omie\n\nomie_app = Omie('sua_app_key', 'seu_app_secret', session=True)\nresponse = omie_app.listar_produtos(pagina=1)\nomie_app.fechar_session()\n\nprint(response)\n```\nO SDK tamb\u00e9m oferece suporte ao uso de gerenciador de contexto para abrir e fechar sess\u00f5es automaticamente. Todas as chamadas com gerenciador de contexto tem por padr\u00e3o o uso da sess\u00e3o.\n\n```python\nfrom omieapi import Omie\nomie_app = Omie('sua_app_key', 'seu_app_secret')\n\nwith omie_app as r:\n response = r.listar_produtos(pagina=1)\n\nprint(response)\n```\n\n\u00c9 poss\u00edvel abrir uma sess\u00e3o utilizando o metodo `Omie.abrir_sess\u00e3o()`\n\n### Exemplo de uso com `httpx`\n\n```python\nfrom omieapi import Omie\n\nomie_app = Omie('sua_app_key', 'seu_app_secret', use_httpx=True)\nresponse = omie_app.listar_produtos(pagina=1)\n\nprint(response)\n\n```\n\n### Ativando Logs para Depura\u00e7\u00e3o\n\n```python\nfrom omieapi import Omie\n\nomie_app = Omie('sua_app_key', 'seu_app_secret', log=True)\nresponse = omie_app.listar_produtos(pagina=1)\n\nprint(response)\n\n```\n\n\n## Contribua com este Projeto\n\nEstamos sempre em busca de melhorias! Um dos pr\u00f3ximos passos para este SDK \u00e9 torn\u00e1-lo realmente multi-linguagem, com suporte a diferentes linguagens de programa\u00e7\u00e3o. J\u00e1 existe um script de scraping que extrai os tipos complexos da API, mas ainda precisamos de ajuda para gerar o c\u00f3digo de maneira automatizada.\n\n### Como Contribuir\n- Clone o reposit\u00f3rio\n- Crie uma nova branch para suas mudan\u00e7as\n- Envie um pull request\n\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Ferramenta para api do omie n\u00e3o oficial",
"version": "0.4.6",
"project_urls": {
"Changelog": "https://github.com/MikalROn/ApiOmie-nao-oficial/blob/main/CHANGELOG.MD",
"Demonstra\u00e7\u00f5es": "https://github.com/MikalROn/ApiOmie-nao-oficial/tree/main/demos",
"Documenta\u00e7\u00e3o": "https://MikalROn.github.io/ApiOmieSDK/",
"Documenta\u00e7\u00e3o Oficial da Omie": "https://developer.omie.com.br/service-list/",
"Download PyPI": "https://pypi.org/project/api-omie/",
"Homepage": "https://github.com/MikalROn/ApiOmie-nao-oficial",
"Reposit\u00f3rio": "https://github.com/MikalROn/ApiOmie-nao-oficial"
},
"split_keywords": [
"omie api",
" api omie",
" omie integra\u00e7\u00e3o",
" omie sdk",
" sdk para omie",
" integra\u00e7\u00e3o omie",
" omie api sdk",
" omieapi",
" apiomiesdk",
" omie sdk",
" automatiza\u00e7\u00e3o omie",
" conex\u00e3o omie",
" desenvolvimento omie",
" omie python",
" api erp omie",
" omie integra\u00e7\u00e3o python",
" omie api integra\u00e7\u00e3o",
" api para omie",
" omie api integra\u00e7\u00e3o"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3af218cf0afb02c4090a483af99a49a40bdeea9dda5759cd70149304b2ccdbc0",
"md5": "e3f47a0dceb2707a3de2bab178ee71e5",
"sha256": "4ca56558cd664c57bedf9a97cf8dbfe0bf0249b5f861e8f8644dc006c5ce6388"
},
"downloads": -1,
"filename": "api_omie-0.4.6.tar.gz",
"has_sig": false,
"md5_digest": "e3f47a0dceb2707a3de2bab178ee71e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 17018,
"upload_time": "2024-10-25T21:21:53",
"upload_time_iso_8601": "2024-10-25T21:21:53.998866Z",
"url": "https://files.pythonhosted.org/packages/3a/f2/18cf0afb02c4090a483af99a49a40bdeea9dda5759cd70149304b2ccdbc0/api_omie-0.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 21:21:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MikalROn",
"github_project": "ApiOmie-nao-oficial",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "api-omie"
}
JSON
