protheustools 0.1.0__py3-none-any.whl

protheustools/__init__.py

@@ -0,0 +1,5 @@
+from .query import exec_query
+from .setup import is_colab, get_timezone, set_timezone, get_locale_info
+
+__all__ = ["exec_query", "is_colab", "get_timezone", "set_timezone", "get_locale_info"]
+__version__ = "0.1.0.dev01"

protheustools/query.py

@@ -0,0 +1,91 @@
+import json
+import base64
+
+import pandas as pd
+import requests
+
+_ENDPOINT = "/psmonitor/QueryEditor/"
+
+_HEADERS = {
+    "Content-Type": "application/json",
+    "tenantid": "04,0002",
+}
+
+
+def exec_query(
+    query: str = '',
+    username: str = '',
+    password: str = '',
+    url: str = '',
+    useDictionary: bool = False,
+) -> pd.DataFrame:
+    """Executa uma query no Protheus via API REST e retorna um DataFrame.
+
+    Args:
+        query: SQL a ser executado.
+        username: Usuário de autenticação da API.
+        password: Senha de autenticação da API.
+        url: URL da API do Protheus.
+        useDictionary: Se True, usa o dicionário do Protheus.
+
+    Returns:
+        DataFrame com os resultados ou DataFrame vazio em caso de erro.
+    """
+    if not query:
+        raise ValueError("Query inválida. Forneça uma query válida.")
+    if not url:
+        raise ValueError("URL inválida. Forneça uma URL válida.")
+    if not username or not password:
+        raise ValueError("Credenciais inválidas. Forneça usuário e senha válidos.")
+
+    url = url + _ENDPOINT
+
+    payload = {
+        "query": query,
+        "params": [],
+        "useDictionary": useDictionary,
+    }
+
+    try:
+        payload_json = json.dumps(payload)
+        payload_base64 = base64.b64encode(payload_json.encode("utf-8")).decode("utf-8")
+        encoded_payload = {"data": payload_base64}
+    except Exception as e:
+        raise ValueError("Erro ao codificar o payload. Verifique a query e os parâmetros.") from e
+
+    try:
+        response = requests.post(
+            url=url,
+            auth=(username, password),
+            headers=_HEADERS,
+            json=encoded_payload,
+            verify=True,
+            timeout=1000,
+        )
+    except Exception as e:
+        raise ConnectionError("Falha na conexão com a API do Protheus.") from e
+
+    if response.status_code == 200:
+        try:
+            data = json.loads(base64.b64decode(response.text))
+            return pd.DataFrame.from_dict(data["results"])
+        except Exception as e:
+            raise ValueError("Erro ao decodificar a resposta da API do Protheus.") from e
+
+    if 300 <= response.status_code < 400:
+        raise ValueError(f"Redirecionamento inesperado: {response.status_code}")
+
+    if 400 <= response.status_code < 500:
+        try:
+            data = json.loads(base64.b64decode(response.text))
+            print(data.get("errorMessage", ""))
+            raise ValueError(f"Erro do cliente: {response.status_code}- {data.get('errorMessage', '')}")
+        except Exception:
+            raise ValueError(f"Erro do cliente: {response.status_code}- {response.text}")
+
+    # 5xx e outros
+    try:
+        cMsg = base64.b64decode(response.text).decode("utf-8")
+    except Exception:
+        cMsg = response.text
+    raise ValueError(f"Erro do servidor ({response.status_code}): {cMsg}")

protheustools/setup.py

@@ -0,0 +1,72 @@
+import tzlocal
+import os
+import sys
+import time
+import requests
+import pytz
+
+def get_locale_info() -> dict:
+    """Retorna informações sobre o fuso horário local da máquina.
+    É importante, porque o firewall do TCloud pode bloquear requisições de países que não sejam Brasil, Estados Unidos ou Canadá.
+
+    Raises:
+        ConnectionError: Falha ao obter informações de localização. Verifique sua conexão com a internet.
+    
+    Returns:
+        dict: Informações sobre o fuso horário local da máquina.
+    """
+    try:
+        dados = requests.get('https://ipinfo.io/json').json()
+        return {
+            "country": dados.get("country"),
+            "region": dados.get("region"),
+            "city": dados.get("city"),
+            "ip": dados.get("ip"),
+            "hostname": dados.get("hostname"),
+            "timezone": dados.get("timezone"),
+            "firewall_tcloud": True if dados.get("country") in ["BR", "US", "CA"] else False
+        }
+    except Exception as e:
+        raise ConnectionError("Falha ao obter informações de localização. Verifique sua conexão com a internet.") from e
+    
+
+
+def get_timezone() -> str:
+    """Retorna o nome do fuso horário local da máquina.
+
+    Returns:
+        str: Nome do fuso horário local da máquina.
+    """
+    return tzlocal.get_localzone_name()
+
+
+def set_timezone(tz_name: str = 'America/Sao_Paulo') -> None:
+    """Define o timezone da máquina
+
+    Args:
+        tz_name (str, optional): Infome o timezone desejado. Defaults to 'America/Sao_Paulo'.
+    """
+    if is_colab():
+        os.environ['TZ'] = tz_name
+        time.tzset()
+    else:
+        try:
+            tz = pytz.timezone(tz_name)
+            os.environ['TZ'] = tz.zone
+            if hasattr(time, 'tzset'):
+                time.tzset()
+        except Exception as e:
+            raise ValueError(f"Erro ao definir o timezone: {tz_name}. Verifique se o timezone é válido.") from e
+    
+
+def is_colab() -> bool:
+    """Retorna True se o código está sendo executado no Google Colab.
+
+    Returns:
+        bool: True se o código está sendo executado no Google Colab, False caso contrário.
+    """
+    try:
+        import google.colab  # noqa: F401
+        return True
+    except ImportError:
+        return False

protheustools-0.1.0.dist-info/METADATA

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: protheustools
+Version: 0.1.0
+Summary: Biblioteca Python com ferramentas para execução de consultas SQL via API REST do Protheus (TOTVS)
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/antoniocostajr/ProtheusTools
+Project-URL: Issues, https://github.com/antoniocostajr/ProtheusTools/issues
+Keywords: protheus,totvs,erp,api,query
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Requires-Dist: pandas>=1.5.0
+Requires-Dist: tzlocal>=4.0
+Requires-Dist: pytz>=2024.1
+Dynamic: license-file
+
+# ProtheusTools
+
+Biblioteca Python com ferramentas para execução de consultas SQL via API REST do Protheus (TOTVS). Os resultados são retornados como `pandas.DataFrame`.
+
+## Instalação
+
+```bash
+pip install protheustools
+```
+
+## Uso
+
+### Consultar dados do Protheus
+
+```python
+from protheustools import exec_query
+
+df = exec_query(
+    query="SELECT A1_COD, A1_NOME FROM SA1010 WHERE D_E_L_E_T_ = ''",
+    username="seu_usuario",
+    password="sua_senha",
+    url="https://seu-servidor.protheus.cloudtotvs.com.br:4050/rest_prd",
+)
+
+print(df.head())
+```
+
+#### Parâmetros de `exec_query`
+
+| Parâmetro       | Tipo    | Padrão  | Descrição                                      |
+|-----------------|---------|---------|------------------------------------------------|
+| `query`         | `str`   | —       | Query SQL a ser executada no Protheus          |
+| `username`      | `str`   | —       | Usuário de autenticação da API REST            |
+| `password`      | `str`   | —       | Senha de autenticação da API REST              |
+| `url`           | `str`   | —       | URL base da API REST do Protheus               |
+| `useDictionary` | `bool`  | `False` | Usa o dicionário de dados do Protheus          |
+
+#### Retorno
+
+Retorna um `pandas.DataFrame` com os resultados da query.
+
+Em caso de erro, levanta exceções:
+
+| Exceção           | Quando ocorre                                                              |
+|-------------------|----------------------------------------------------------------------------|
+| `ValueError`      | `query`, `url` ou credenciais não informados                               |
+| `ValueError`      | Erro ao codificar o payload da requisição                                  |
+| `ValueError`      | Redirecionamento inesperado (HTTP 3xx)                                     |
+| `ValueError`      | Erro do cliente na API (HTTP 4xx) — inclui a mensagem de erro da API       |
+| `ValueError`      | Erro do servidor (HTTP 5xx) — inclui a mensagem de erro                    |
+| `ValueError`      | Erro ao decodificar a resposta da API                                      |
+| `ConnectionError` | Falha na conexão com a API do Protheus                                     |
+
+### Gerenciar informações de localização e timezone
+
+#### Obter informações de localização
+
+```python
+from protheustools import get_locale_info
+
+info = get_locale_info()
+print(info)
+# {
+#     'country': 'BR',
+#     'region': 'SP',
+#     'city': 'São Paulo',
+#     'ip': '192.168.1.1',
+#     'hostname': 'meu-pc',
+#     'timezone': 'America/Sao_Paulo',
+#     'firewall_tcloud': True
+# }
+```
+
+**Nota:** Esta função verifica automaticamente se seu IP está em um país permitido pelo firewall do TCloud (Brasil, Estados Unidos ou Canadá).
+
+#### Obter timezone atual
+
+```python
+from protheustools import get_timezone
+
+tz = get_timezone()
+print(tz)  # 'America/Sao_Paulo'
+```
+
+#### Definir timezone
+
+```python
+from protheustools import set_timezone
+
+set_timezone('America/Sao_Paulo')  # Padrão
+# ou
+set_timezone('America/New_York')
+```
+
+### Detectar Google Colab
+
+```python
+from protheustools import is_colab
+
+if is_colab():
+    print("Executando no Google Colab")
+else:
+    print("Executando localmente")
+```
+
+## Requisitos
+
+- Python 3.8+
+- `requests >= 2.28.0`
+- `pandas >= 1.5.0`
+- `tzlocal >= 4.0`

protheustools-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+protheustools/__init__.py,sha256=c9Ag5mKqBkN1GqOMVfzNEowLJBmiAO4qtHhF4iour2U,220
+protheustools/query.py,sha256=8VducWHBaWBRzYhyceIyJzked7KqVaHUjhXrwPMj4k8,2876
+protheustools/setup.py,sha256=hzxSPKcFjFpwB08Vjvt5bol2SVdTGm4Un-8hUwhLu3k,2279
+protheustools-0.1.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+protheustools-0.1.0.dist-info/METADATA,sha256=yCf_7tKsq4PiDHvbdIqihex1bRxEJFjnVgj5FFXdHXk,4512
+protheustools-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+protheustools-0.1.0.dist-info/top_level.txt,sha256=nrF9RTsNJCAAY2LdCIVNOr-Z8UACL7k1LaKxhWBxLEw,14
+protheustools-0.1.0.dist-info/RECORD,,

protheustools-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

protheustools-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

protheustools-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+protheustools