brdata 0.2.7
Conjunto de fontes de dados do mercado financeiro brasileiro
License: MIT
Requires Python: >=3.7.10,<4.0.0
Keywords: b3,fundamentus,dados,brasil,finanças

<div align="center">

<a href="https://github.com/gabrielguarisa/brdata/"><img src="https://raw.githubusercontent.com/gabrielguarisa/brdata/master/logo.svg" alt="brdata"></a>

[![Python Version](https://img.shields.io/pypi/pyversions/brdata.svg)](https://pypi.org/project/brdata/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/gabrielguarisa/brdata/blob/master/.pre-commit-config.yaml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/gabrielguarisa/brdata/blob/master/LICENSE)
[![Package version](https://img.shields.io/pypi/v/brdata?color=%2334D058&label=pypi%20package)](https://pypi.org/project/brdata)

<em>Conjunto de fontes de dados do mercado financeiro brasileiro</em>

</div>

## Instalação

```bash
pip install brdata
```

## Exemplos

### B3

Python:

```python
from brdata import b3

print(b3.indices())
```

CLI:

```bash
brdata b3 indices
```

### Fundamentus

Python:

```python
from brdata import fundamentus

print(fundamentus.resultados())
```

CLI:

```bash
brdata fundamentus resultados
```
## Configuração do ambiente de desenvolvimento

Iniciando o poetry e configurando o `pre-commit`:

```bash
make init
```

Verifica o codestyle:

```bash
make codestyle
```

### Versionamento do pacote

Uma nova versão pode ser definada usando o comando:

```bash
poetry version <version>
```

A versão pode ser definida explicitamente, ou como `major`, `minor`, ou `patch`. Para mais detalhes, ver o padrão [Semantic Versions](https://semver.org/).

### Makefile

O [`Makefile`](https://github.com/gabrielguarisa/brdata/blob/master/Makefile) contém funções para um desenvolvimento mais rápido.


<details>
<summary>1. Instalação das dependências e dos pre-commit hooks</summary>
<p>

Instalando as dependências:

```bash
make install
```

Configurando os hooks do pre-commit:

```bash
make pre-commit-install
```

Também é possível executar os dois comandos através do `make init`.

</p>
</details>

<details>
<summary>2. Codestyle</summary>
<p>

Formatação automática com `pyupgrade`, `isort` e `black`:

```bash
make formatting
```

Fazendo apenas a verificação, sem alterar os arquivos:

```bash
make check-codestyle
```

> `check-codestyle` usa `isort`, `black` e `darglint`

</p>
</details>

<details>
<summary>3. Segurança</summary>
<p>

Executa as verificações de integridade do `Poetry` e identifica problemas de segurança com o `Safety`:

```bash
make check-safety
```

</p>
</details>

<details>
<summary>4. Testes</summary>
<p>

Executando testes com `pytest`:

```bash
make test
```

</p>
</details>

<details>
<summary>5. Todos os linters</summary>
<p>

```bash
make lint
```

Tem o mesmo resultado que:

```bash
make test && make check-codestyle && make check-safety
```

</p>
</details>

<details>
<summary>6. Limpeza</summary>
<p>

Deletando pycache:

```bash
make pycache-remove
```

Removendo o package build:

```bash
make build-remove
```

A execução dos dois comandos também pode ser feita através de:

```bash
make clean
```

</p>
</details>

## 🛡 Licença

Este projeto está licenciado sob os termos da licença `MIT`.