# Gender Guesser Brasil
### [Powered by DadosAbertosBrasil](https://www.gustavofurtado.com/dab.html)
Versão brasileira do pacote Python para adivinhar o gênero de um nome próprio.
Este pacote utiliza o DadosAbertosBrasil para capturar informações do Censo Demográfico das APIs oficiais do IBGE e calcula a probabilidade de que determinado nome próprio seja feminino ou masculino.
## Instalação
```pip install gender-guesser-br```
## Fazendo previsões
Após importar o pacote, crie uma instância do objeto `Genero` usando o nome próprio como argumento. Por fim, utilize o método `__call__` para conferir a previsão.
```python
>>> from gender_guesser_br import Genero
>>> nome = Genero("gustavo")
>>> nome()
'masculino'
```
É possível utilizar o argumento `uf` para fazer uma previsão por unidade federativa, o que pode aumentar a precisão. Veja que "Darci" é um nome que pode receber qualquer classificação, dependendo da UF.
```python
>>> rs = Genero(nome="darci", uf="rs")
>>> rs()
'masculino'
>>> sc = Genero(nome="darci", uf="sc")
>>> sc()
'provavelmente_masculino'
>>> sp = Genero(nome="darci", uf="sp")
>>> sp()
'ambos'
>>> ac = Genero(nome="darci", uf="ac")
>>> ac()
'feminino'
>>> rr = Genero(nome="darci", uf="rr")
>>> rr()
'desconhecido'
```
Os argumentos `nome` e `uf` são case insensitive, então você pode usar letras maiúsculas e minúsculas como quiser, desde que uf seja a sigla de duas letras da UF ou o código IBGE de dois dígitos. Utilize a função `localidade` do DadosAbertosBrasil para obter uma lista completa dos códigos das UFs.
```python
>>> from DadosAbertosBrasil import ibge
>>> ibge.localidades(nivel="estados")
```
## Refinando resultados
Ao fazer a previsão, utilize os argumentos `corte_ambos` e `corte_maioria` para definir qual é a proporção mínima em que o objeto para a ter certeza de que o nome é de determinado gênero ou que é considerado de ambos os gêneros.
```python
>>> ariel = Genero("Ariel", uf="RJ")
>>> ariel(corte_ambos=0.8, corte_maioria=0.9)
'ambos'
>>> ariel(corte_ambos=0.6, corte_maioria=0.8)
'provavelmente_masculino'
>>> ariel(corte_ambos=0.6, corte_maioria=0.7)
'masculino'
```
Para ter ainda mais controle, utilize as propriedades `f` e `m` para obter acesso aos números brutos.
Essas propriedades são dicionários contendo o número total de habitantes do gênero correspondente que possuem aquele nome e a proporção do gênero.
```python
>>> camila = Genero("Camila")
>>> camila.f
{'absoluto': 469851, 'percentual': 0.9964012147225733}
>>> camila.m
{'absoluto': 1697, 'percentual': 0.003598785277426688}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/GusFurtado/gender_guesser_br",
"name": "gender-guesser-br",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "brasil,ibge,dadosabertos,gender,genero",
"author": "Gustavo Furtado",
"author_email": "gustavofurtado2@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9d/35/4222310c9da7ed349595b0bc965048057ed234a3dd9a80f30df6dd258d52/gender_guesser_br-1.0.0.tar.gz",
"platform": null,
"description": "# Gender Guesser Brasil\r\n### [Powered by DadosAbertosBrasil](https://www.gustavofurtado.com/dab.html)\r\n\r\nVers\u00e3o brasileira do pacote Python para adivinhar o g\u00eanero de um nome pr\u00f3prio.\r\n\r\nEste pacote utiliza o DadosAbertosBrasil para capturar informa\u00e7\u00f5es do Censo Demogr\u00e1fico das APIs oficiais do IBGE e calcula a probabilidade de que determinado nome pr\u00f3prio seja feminino ou masculino.\r\n\r\n## Instala\u00e7\u00e3o\r\n\r\n```pip install gender-guesser-br```\r\n\r\n## Fazendo previs\u00f5es\r\n\r\nAp\u00f3s importar o pacote, crie uma inst\u00e2ncia do objeto `Genero` usando o nome pr\u00f3prio como argumento. Por fim, utilize o m\u00e9todo `__call__` para conferir a previs\u00e3o.\r\n\r\n```python\r\n>>> from gender_guesser_br import Genero\r\n\r\n>>> nome = Genero(\"gustavo\")\r\n>>> nome()\r\n'masculino'\r\n```\r\n\r\n\u00c9 poss\u00edvel utilizar o argumento `uf` para fazer uma previs\u00e3o por unidade federativa, o que pode aumentar a precis\u00e3o. Veja que \"Darci\" \u00e9 um nome que pode receber qualquer classifica\u00e7\u00e3o, dependendo da UF.\r\n\r\n```python\r\n>>> rs = Genero(nome=\"darci\", uf=\"rs\")\r\n>>> rs()\r\n'masculino'\r\n\r\n>>> sc = Genero(nome=\"darci\", uf=\"sc\")\r\n>>> sc()\r\n'provavelmente_masculino'\r\n\r\n>>> sp = Genero(nome=\"darci\", uf=\"sp\")\r\n>>> sp()\r\n'ambos'\r\n\r\n>>> ac = Genero(nome=\"darci\", uf=\"ac\")\r\n>>> ac()\r\n'feminino'\r\n\r\n>>> rr = Genero(nome=\"darci\", uf=\"rr\")\r\n>>> rr()\r\n'desconhecido'\r\n```\r\n\r\nOs argumentos `nome` e `uf` s\u00e3o case insensitive, ent\u00e3o voc\u00ea pode usar letras mai\u00fasculas e min\u00fasculas como quiser, desde que uf seja a sigla de duas letras da UF ou o c\u00f3digo IBGE de dois d\u00edgitos. Utilize a fun\u00e7\u00e3o `localidade` do DadosAbertosBrasil para obter uma lista completa dos c\u00f3digos das UFs.\r\n\r\n```python\r\n>>> from DadosAbertosBrasil import ibge\r\n>>> ibge.localidades(nivel=\"estados\")\r\n```\r\n\r\n## Refinando resultados\r\n\r\nAo fazer a previs\u00e3o, utilize os argumentos `corte_ambos` e `corte_maioria` para definir qual \u00e9 a propor\u00e7\u00e3o m\u00ednima em que o objeto para a ter certeza de que o nome \u00e9 de determinado g\u00eanero ou que \u00e9 considerado de ambos os g\u00eaneros.\r\n\r\n```python\r\n>>> ariel = Genero(\"Ariel\", uf=\"RJ\")\r\n>>> ariel(corte_ambos=0.8, corte_maioria=0.9)\r\n'ambos'\r\n\r\n>>> ariel(corte_ambos=0.6, corte_maioria=0.8)\r\n'provavelmente_masculino'\r\n\r\n>>> ariel(corte_ambos=0.6, corte_maioria=0.7)\r\n'masculino'\r\n```\r\n\r\nPara ter ainda mais controle, utilize as propriedades `f` e `m` para obter acesso aos n\u00fameros brutos.\r\n\r\nEssas propriedades s\u00e3o dicion\u00e1rios contendo o n\u00famero total de habitantes do g\u00eanero correspondente que possuem aquele nome e a propor\u00e7\u00e3o do g\u00eanero.\r\n\r\n```python\r\n>>> camila = Genero(\"Camila\")\r\n>>> camila.f\r\n{'absoluto': 469851, 'percentual': 0.9964012147225733}\r\n\r\n>>> camila.m\r\n{'absoluto': 1697, 'percentual': 0.003598785277426688}\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Vers\u00e3o brasileira do pacote Python para adivinhar o g\u00eanero de um nome pr\u00f3prio.",
"version": "1.0.0",
"project_urls": {
"Download": "https://github.com/GusFurtado/gender_guesser_br/archive/1.0.0.tar.gz",
"Homepage": "https://github.com/GusFurtado/gender_guesser_br"
},
"split_keywords": [
"brasil",
"ibge",
"dadosabertos",
"gender",
"genero"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b1a9aaef7d11195bd424def9bcd23e8cb84c07127a2ae2cc31374faecd43a598",
"md5": "0b6a66bb6629fe9ee54391635a068413",
"sha256": "ac1df746c6a1029d2eacfef2c84bf2b10faeb3081d73484dfbc070cf0c5706bd"
},
"downloads": -1,
"filename": "gender_guesser_br-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b6a66bb6629fe9ee54391635a068413",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5162,
"upload_time": "2024-02-13T01:48:54",
"upload_time_iso_8601": "2024-02-13T01:48:54.192904Z",
"url": "https://files.pythonhosted.org/packages/b1/a9/aaef7d11195bd424def9bcd23e8cb84c07127a2ae2cc31374faecd43a598/gender_guesser_br-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d354222310c9da7ed349595b0bc965048057ed234a3dd9a80f30df6dd258d52",
"md5": "70740298889b3b0017ddedd447bf4475",
"sha256": "936c019e97dffab8ee3db756c27eb5b9cc6a54e17e7a92f92ad23215d7da296b"
},
"downloads": -1,
"filename": "gender_guesser_br-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "70740298889b3b0017ddedd447bf4475",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4847,
"upload_time": "2024-02-13T01:48:55",
"upload_time_iso_8601": "2024-02-13T01:48:55.946784Z",
"url": "https://files.pythonhosted.org/packages/9d/35/4222310c9da7ed349595b0bc965048057ed234a3dd9a80f30df6dd258d52/gender_guesser_br-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-13 01:48:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GusFurtado",
"github_project": "gender_guesser_br",
"github_not_found": true,
"lcname": "gender-guesser-br"
}