Skip to content

Commit 3d2a5dc

Browse files
IvanildoBaraunaIvanildoBarauna
authored
Merge pull request #11 from ivanildobarauna-dev/feature/UpdateVersion
FEATURE - Update Version and adjusts for Beta Release
2 parents 59968fe + a3b730d commit 3d2a5dc

File tree

14 files changed

+297
-143
lines changed

14 files changed

+297
-143
lines changed

‎.pre-commit-config.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.6.0
4+
hooks:
5+
- id: check-yaml
6+
- id: trailing-whitespace

‎LICENSE

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
MIT License
22

3-
Copyright (c) 2023 apigratis
3+
Copyright (c) 2024 Ivanildo Barauna de Souza Junior
44

5-
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:
6-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
711

8-
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
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
921
SOFTWARE.

‎poetry.lock

+111-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pyproject.toml

+14-11
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
[tool.poetry]
22
name = "api-brasil"
3-
version = "2.0.4"
4-
description = "A ideia desse SDK é otimizar o tempo de código dos usuários auxiliando na integração com a plataforma."
3+
version = "2.0.0"
4+
description = "Este SDK foi desenvolvido para simplificar e agilizar a integração com a plataforma APIBrasil, reduzindo o esforço de desenvolvimento e otimizando o tempo dos usuários."
55
license = "MIT"
66
readme = "README.md"
77
authors = [
88
"Ivanildo Barauna de Souza Junior <[email protected]>",
99
"APIBRASIL <[email protected]>"
1010
]
11-
classifiers = [
12-
"Intended Audience :: Developers",
13-
"Programming Language :: Python :: 3",
14-
"License :: OSI Approved :: MIT License",
15-
"Operating System :: OS Independent",
11+
classifiers=[
12+
"Development Status :: 4 - Beta",
13+
"Intended Audience :: Developers",
14+
"License :: OSI Approved :: MIT License",
15+
"Programming Language :: Python :: 3",
16+
"Programming Language :: Python :: 3.8",
1617
]
1718

1819

@@ -22,17 +23,19 @@ include = ["api-brasil*"]
2223

2324

2425
[tool.poetry.dependencies]
25-
python = ">=3.8"
26+
python = ">=3.9"
2627
requests = "^2.32.3"
2728

2829
[tool.poetry.group.dev.dependencies]
2930
pytest = "^8.3.3"
3031
python-dotenv = "^1.0.1"
32+
black = "^24.10.0"
3133

3234
[tool.poetry.urls]
33-
Homepage = "https://github.com/APIBrasil/apigratis-sdk-python"
34-
Repository = "https://github.com/APIBrasil/apigratis-sdk-python.git"
35-
BugTracker = "https://github.com/APIBrasil/apigratis-sdk-python/issues"
35+
Homepage = "https://apibrasi.com.br"
36+
API-Docs = "https://apibrasil.com.br/documentacoes"
37+
Repository = "https://github.com/ivanildobarauna-dev/apibrasil-py"
38+
BugTracker = "https://github.com/ivanildobarauna-dev/apibrasil-py/issues"
3639

3740

3841
[build-system]

‎src/api_brasil/__init__.py

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
""" API Brasil - Python Client """
2+
23
from api_brasil.api_client.client_builder import APIBrasilClient
34
from api_brasil.features.whatsapp import WhatsAppApi
45
from api_brasil.features.vehicles import VehiclesApi
@@ -10,12 +11,12 @@
1011

1112

1213
__all__ = [
13-
"APIBrasilClient",
14-
"WhatsAppApi",
15-
"VehiclesApi",
16-
"CNPJApi",
17-
"CPFApi",
18-
"CorreiosAPI",
19-
"CEPGeoLocationAPI",
20-
"SMSApi"
21-
]
14+
"APIBrasilClient",
15+
"WhatsAppApi",
16+
"VehiclesApi",
17+
"CNPJApi",
18+
"CPFApi",
19+
"CorreiosAPI",
20+
"CEPGeoLocationAPI",
21+
"SMSApi",
22+
]

‎src/api_brasil/api_client/client_builder.py

+36-31
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,49 @@
1-
21
from typing import Tuple
32
import json
43
import requests
54

5+
66
class APIBrasilClient:
77
BASE_URL: str = "https://gateway.apibrasil.io/api/v2"
88
""" The client class is responsible for provide credentials to feature's ApiBrasil """
9-
def __init__(self,
10-
bearer_token: str,
11-
user_agent: str = "APIBrasil/Python-SDK") -> None:
12-
9+
10+
def __init__(
11+
self, bearer_token: str, user_agent: str = "APIBrasil/Python-SDK"
12+
) -> None:
13+
1314
self.bearer_token = bearer_token
1415
self.user_agent = user_agent
15-
16+
1617
def _headers(self, device_token: str) -> dict:
1718
headers = {
18-
'Content-Type': 'application/json',
19-
'Authorization': 'Bearer ' + self.bearer_token,
20-
'DeviceToken': device_token,
21-
'User-Agent': self.user_agent
22-
}
23-
19+
"Content-Type": "application/json",
20+
"Authorization": "Bearer " + self.bearer_token,
21+
"DeviceToken": device_token,
22+
"User-Agent": self.user_agent,
23+
}
24+
2425
return headers
2526

26-
def post_request(self, endpoint: str, device_token: str, body: str) -> Tuple[dict, int]:
27-
url = self.BASE_URL + endpoint
28-
response = requests.post(url=url,
29-
headers=self._headers(device_token=device_token),
30-
data=json.dumps(body),
31-
allow_redirects=True,
32-
stream=True)
33-
34-
if not (200 <= response.status_code < 300):
35-
raw_response = {
36-
"is_error": response.json()["error"],
37-
"response_status_code": response.status_code,
38-
"response_reason": response.reason,
39-
"response_body": response.json()
40-
}
41-
42-
return json.dumps(raw_response, indent=4), response.status_code
43-
44-
return json.dumps(response.json(), indent=4), response.status_code
27+
def post_request(
28+
self, endpoint: str, device_token: str, body: str
29+
) -> Tuple[dict, int]:
30+
url = self.BASE_URL + endpoint
31+
response = requests.post(
32+
url=url,
33+
headers=self._headers(device_token=device_token),
34+
data=json.dumps(body),
35+
allow_redirects=True,
36+
stream=True,
37+
)
38+
39+
if not (200 <= response.status_code < 300):
40+
raw_response = {
41+
"is_error": response.json()["error"],
42+
"response_status_code": response.status_code,
43+
"response_reason": response.reason,
44+
"response_body": response.json(),
45+
}
46+
47+
return json.dumps(raw_response, indent=4), response.status_code
48+
49+
return json.dumps(response.json(), indent=4), response.status_code

‎src/api_brasil/features/cep_geolocation/__init__.py

+11-8
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,31 @@
33

44

55
class CEPGeoLocationAPI(APIBrasilFeature):
6-
""" Class to interact with the Vehicles API. """
6+
"""Class to interact with the Vehicles API."""
7+
78
def __init__(self, api_brasil_client: APIBrasilClient, device_token: str):
89
self.api_brasil_client = api_brasil_client
910
self.device_token = device_token
1011

1112
def set_cep(self, cep: str):
12-
""" Set the plate to be used in the API requests """
13+
"""Set the plate to be used in the API requests"""
1314
self.cep = cep
14-
15+
1516
def consulta(self) -> tuple:
16-
""" Method to consult the API with the plate set in the class. """
17+
"""Method to consult the API with the plate set in the class."""
1718
endpoint = "/cep/cep"
1819

1920
if not self.cep:
20-
raise ValueError("The CEP number is not set. Use the 'set_cep' method to set the CEP.")
21-
21+
raise ValueError(
22+
"The CEP number is not set. Use the 'set_cep' method to set the CEP."
23+
)
24+
2225
response, status_code = self.api_brasil_client.post_request(
2326
endpoint=endpoint,
2427
device_token=self.device_token,
2528
body={
2629
"cep": self.cep,
27-
}
30+
},
2831
)
2932

30-
return response, status_code
33+
return response, status_code

0 commit comments

Comments
 (0)