|
59 | 59 | - [get\_address\_from\_cep](#get_address_from_cep) |
60 | 60 | - [get\_cep\_information\_from\_address](#get_cep_information_from_address) |
61 | 61 | - [Date](#date) |
62 | | - - [convert\_date\_to_text](#convert_date_to_text) |
| 62 | + - [convert\_date\_to_text](#convert_date_to_text) |
63 | 63 | - [Phone](#phone) |
64 | 64 | - [is\_valid\_phone](#is_valid_phone) |
65 | 65 | - [format\_phone](#format_phone) |
|
91 | 91 | - [generate_voter_id](#generate_voter_id) |
92 | 92 | - [IBGE](#ibge) |
93 | 93 | - [convert_code_to_uf](#convert_code_to_uf) |
94 | | - - [get\_municipality\_by\_code](#get_municipality_by_code) |
95 | 94 | - [get_code_by_municipality_name](#get_code_by_municipality_name) |
| 95 | + - [get\_municipality\_by\_code](#get_municipality_by_code) |
96 | 96 | - [Holidays](#holidays) |
97 | 97 | - [is_holiday](#is_holiday) |
98 | 98 | - [Monetary](#monetary) |
@@ -459,15 +459,15 @@ Example: |
459 | 459 |
|
460 | 460 | ## Date |
461 | 461 |
|
462 | | -### convert_date_to_text |
| 462 | +### convert_date_to_text |
463 | 463 | Convert a brazilian date (dd/mm/yyyy) format in their portuguese textual representation. |
464 | 464 |
|
465 | 465 | Args: |
466 | 466 | - date (str): A date in a string format dd/mm/yyyy. |
467 | 467 |
|
468 | 468 | Return: |
469 | 469 | - (str) | None: A portuguese textual representation of the date or None case a date is invalid. |
470 | | - |
| 470 | + |
471 | 471 |
|
472 | 472 | Example: |
473 | 473 |
|
@@ -1147,25 +1147,6 @@ Exemplo: |
1147 | 1147 | >>> |
1148 | 1148 | ``` |
1149 | 1149 |
|
1150 | | -### get_municipality_by_code |
1151 | | - |
1152 | | -Returns the municipality name and UF for a given IBGE code. |
1153 | | - |
1154 | | -Args: |
1155 | | - * code (str): The IBGE code of the municipality. |
1156 | | - |
1157 | | -Returns: |
1158 | | - * tuple: Returns a tuple formatted as ("Município", "UF"). |
1159 | | - * None: Returns None if the code is not valid. |
1160 | | - |
1161 | | -Example: |
1162 | | - |
1163 | | -```python |
1164 | | ->>> from brutils import get_municipality_by_code |
1165 | | ->>> get_municipality_by_code(3550308) |
1166 | | -("São Paulo", "SP") |
1167 | | -``` |
1168 | | - |
1169 | 1150 | ### get_code_by_municipality_name |
1170 | 1151 |
|
1171 | 1152 | Returns the IBGE code for a given municipality name and uf code. |
@@ -1200,6 +1181,25 @@ None |
1200 | 1181 | None |
1201 | 1182 | ``` |
1202 | 1183 |
|
| 1184 | +### get_municipality_by_code |
| 1185 | + |
| 1186 | +Returns the municipality name and UF for a given IBGE code. |
| 1187 | + |
| 1188 | +Args: |
| 1189 | + * code (str): The IBGE code of the municipality. |
| 1190 | + |
| 1191 | +Returns: |
| 1192 | + * tuple: Returns a tuple formatted as ("Município", "UF"). |
| 1193 | + * None: Returns None if the code is not valid. |
| 1194 | + |
| 1195 | +Example: |
| 1196 | + |
| 1197 | +```python |
| 1198 | +>>> from brutils import get_municipality_by_code |
| 1199 | +>>> get_municipality_by_code(3550308) |
| 1200 | +("São Paulo", "SP") |
| 1201 | +``` |
| 1202 | + |
1203 | 1203 | ## Holidays |
1204 | 1204 |
|
1205 | 1205 | ### is_holiday |
@@ -1236,8 +1236,8 @@ True |
1236 | 1236 |
|
1237 | 1237 | ### format_currency |
1238 | 1238 |
|
1239 | | -Formats a number following the Brazilian monetary standard. The number will be |
1240 | | -formatted by adding the R$ symbol as a prefix, a comma as a decimal separator, and a |
| 1239 | +Formats a number following the Brazilian monetary standard. The number will be |
| 1240 | +formatted by adding the R$ symbol as a prefix, a comma as a decimal separator, and a |
1241 | 1241 | period as a thousands grouper. |
1242 | 1242 |
|
1243 | 1243 | Args: |
@@ -1333,4 +1333,4 @@ Let's build it together 🚀🚀 |
1333 | 1333 | <img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" /> |
1334 | 1334 | </a></br></br> |
1335 | 1335 |
|
1336 | | -_Made with [contrib.rocks](https://contrib.rocks)._ |
| 1336 | +_Made with [contrib.rocks](https://contrib.rocks)._ |
0 commit comments