Metadata-Version: 2.4
Name: BacenAPI
Version: 0.2.0
Summary: tools for manipulating time series data from the Central Bank of Brazil
Author: Paulo Icaro, Lissandro Costa de Sousa, Francisco Gildemir Ferreira da Silva
Author-email: lisandrosousa54@gmail.com
License: MIT
Keywords: time-serie,api_data,central_bank
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: License.md
Requires-Dist: pandas
Requires-Dist: requests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

### 📄 `README.md`

````markdown
# BacenAPI

**BacenAPI** is a Python package designed to simplify the access and manipulation of time 
series data from the Central Bank of Brazil (Banco Central do Brasil - BCB), using its 
public API (SGS - Sistema Gerenciador de Séries Temporais).

---

## 📦 Features

- 🔍 **Search series** using keywords in the metadata
- 🔗 **Generate URLs** for one or more time series from BCB's SGS API
- 📊 **Download and structure** the time series data into a unified `pandas.DataFrame`
- 📁 Supports integration with local metadata files in `.txt` or `.parquet` formats

---

## 🚀 Installation

```bash
pip install BacenAPI
````

Or, if you're developing locally:

```bash
git clone https://github.com/LissandroSousa/BacenAPI.py.git
cd BacenAPI
pip install -e .
```

---

## 🧩 Dependencies

- `pandas`
- `requests`

---

## 🛠️ Usage Example

```python
from BacenAPI import bacen_search, bacen_url, bacen_series

# Search for time series by keyword
df_search = bacen_search("IPCA")
print(df_search)

# Get URLs for a specific set of series
urls = bacen_url(series=[433, 4440], start_date="01/01/2020", end_date="01/01/2024")

# Download the data and format as DataFrame
df = bacen_series(urls)
print(df.head())
```

---

## 📂 Project Structure

```
BacenAPI/
├── BacenAPI/
│   ├── __init__.py
│   ├── bacen_url.py
│   ├── bacen_series.py
│   ├── bacen_search.py
│
├── Date/
│   └── dataset.txt
├── setup.py
├── requirements.txt
├── LICENSE
├── README.md
```

---

## 👥 Authors

- Paulo Andre
- Lissandro Costa de Sousa
- Prof. Francisco Gildemir Ferreira da Silva *(Supervisor)*

---

## 📄 License

This project is licensed under the **MIT License**. See the [`LICENSE`](./LICENSE) file for more details.

---

## 📫 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

---

## 🌐 Source and Documentation

- Official API: [https://dadosabertos.bcb.gov.br/dataset/serie-historica-dos-indicadores-economicos](https://dadosabertos.bcb.gov.br/dataset/serie-historica-dos-indicadores-economicos)
- SGS API Docs: [https://www3.bcb.gov.br/sgspub/localizarseries/localizarSeries.do?method=prepararTelaLocalizarSeries](https://www3.bcb.gov.br/sgspub/localizarseries/localizarSeries.do?method=prepararTelaLocalizarSeries)
