| Name | omie-python JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Client for the Omie ERP API |
| upload_time | 2024-05-02 13:12:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Lucas Schneider Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
omie
api
client
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# omie-python
Interface simples em Python para a Omie API.
Este projeto está em fase de testes, portanto algumas coisas podem quebrar inesperadamente.
## Quickstart
Instalação:
```
git clone https://github.com/schneider8357/omie-python
cd omie-python
pip install -r requirements.txt
```
Crie um arquivo .env para armazenar a sua app_key e secret_key:
```
OMIE_APP_KEY='3833xxxxxxx'
OMIE_APP_SECRET='fed2xxxxxxxxxxxxxxxxxxxxxxxxxxxx'
```
Utilização:
```python
api = omie.OmieClient(app_key, app_secret)
data = {
"nPagina": 2,
"nRegPorPagina": 1,
}
```
> [!IMPORTANT]
> Não deixe as suas chaves app_key e app_secret no seu código! Ao invés disso, utilize a biblioteca python-dotenv
## Methods
Consulte os métodos no arquivo `omie/methods.py`
Os métodos já implementados são:
- **ConsultarPedido**
- **ListarEtapasPedido**
- **ListarEtapasFaturamento**
- **ConsultarVendedor**
- **ConsultarProjeto**
Ainda faltam implementar, pelo menos:
- **AlterarProduto**
- **ConsultarCliente**
- **ListarCenarios**
- **ListarClientes**
- **ListarLocaisEstoque**
- **ListarImpostosCenario**
- **ListarPosEstoque**
- **ListarProdutos**
- **ListarTabelaItens**
- **ListarTabelasPreco**
## Schemas
O schema é uma forma de validar os dados que serão enviados para a Omie API.
Para esta validação, a biblioteca pydantic é utilizada. Ela valida os tipos
dos dados e exporta os modelos para JSON. Confira os exemplos em `omie/schemas.py`.
Raw data
{
"_id": null,
"home_page": null,
"name": "omie-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "omie, api, client",
"author": null,
"author_email": "Lucas Schneider <lucasschneider.dev@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d8/a2/2b10a6e08e8bd3944b4dffafd3f514a7bbd25a42d01b6cb2a65facfb30cc/omie_python-0.0.1.tar.gz",
"platform": null,
"description": "# omie-python\nInterface simples em Python para a Omie API.\n\nEste projeto est\u00e1 em fase de testes, portanto algumas coisas podem quebrar inesperadamente.\n\n\n## Quickstart\n\nInstala\u00e7\u00e3o:\n\n```\ngit clone https://github.com/schneider8357/omie-python\ncd omie-python\npip install -r requirements.txt\n```\n\nCrie um arquivo .env para armazenar a sua app_key e secret_key:\n\n```\nOMIE_APP_KEY='3833xxxxxxx'\nOMIE_APP_SECRET='fed2xxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n```\n\nUtiliza\u00e7\u00e3o:\n\n```python\napi = omie.OmieClient(app_key, app_secret)\n\ndata = {\n \"nPagina\": 2,\n \"nRegPorPagina\": 1,\n}\n```\n\n> [!IMPORTANT] \n> N\u00e3o deixe as suas chaves app_key e app_secret no seu c\u00f3digo! Ao inv\u00e9s disso, utilize a biblioteca python-dotenv\n\n\n## Methods\n\nConsulte os m\u00e9todos no arquivo `omie/methods.py`\n\nOs m\u00e9todos j\u00e1 implementados s\u00e3o: \n\n- **ConsultarPedido**\n- **ListarEtapasPedido**\n- **ListarEtapasFaturamento**\n- **ConsultarVendedor**\n- **ConsultarProjeto**\n\nAinda faltam implementar, pelo menos:\n- **AlterarProduto**\n- **ConsultarCliente**\n- **ListarCenarios**\n- **ListarClientes**\n- **ListarLocaisEstoque**\n- **ListarImpostosCenario**\n- **ListarPosEstoque**\n- **ListarProdutos**\n- **ListarTabelaItens**\n- **ListarTabelasPreco**\n\n## Schemas\n\nO schema \u00e9 uma forma de validar os dados que ser\u00e3o enviados para a Omie API.\nPara esta valida\u00e7\u00e3o, a biblioteca pydantic \u00e9 utilizada. Ela valida os tipos\ndos dados e exporta os modelos para JSON. Confira os exemplos em `omie/schemas.py`.\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Lucas Schneider Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Client for the Omie ERP API",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/schneider8357/omie-python"
},
"split_keywords": [
"omie",
" api",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e83fdf7130f2c3cea0ef682750a9c95065bfa461822dc4d4cabcf5cb262b5b5f",
"md5": "61e3d377e4a891efb741d5c349e2e3a8",
"sha256": "02053e84cf0c20836eac388007c8f639544b5e7af9e17c572146f9b3e689287d"
},
"downloads": -1,
"filename": "omie_python-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61e3d377e4a891efb741d5c349e2e3a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8806,
"upload_time": "2024-05-02T13:12:24",
"upload_time_iso_8601": "2024-05-02T13:12:24.716014Z",
"url": "https://files.pythonhosted.org/packages/e8/3f/df7130f2c3cea0ef682750a9c95065bfa461822dc4d4cabcf5cb262b5b5f/omie_python-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8a22b10a6e08e8bd3944b4dffafd3f514a7bbd25a42d01b6cb2a65facfb30cc",
"md5": "fb6e7d15065ad1cd57335df31c3ff5fc",
"sha256": "a7f5f3e2281c9664f4d64ab64705ed904ba8a42767061912d734a8a05d9e8b4f"
},
"downloads": -1,
"filename": "omie_python-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "fb6e7d15065ad1cd57335df31c3ff5fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7679,
"upload_time": "2024-05-02T13:12:26",
"upload_time_iso_8601": "2024-05-02T13:12:26.702859Z",
"url": "https://files.pythonhosted.org/packages/d8/a2/2b10a6e08e8bd3944b4dffafd3f514a7bbd25a42d01b6cb2a65facfb30cc/omie_python-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 13:12:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "schneider8357",
"github_project": "omie-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "omie-python"
}
