https://github.com/bratergit/brazilstocks
Brazilian Financial Markets Toolkit
https://github.com/bratergit/brazilstocks
b3 bovespa bovespa-stocks hacktoberfest hacktoberfest-accepted stocks stocks-api
Last synced: 4 months ago
JSON representation
Brazilian Financial Markets Toolkit
- Host: GitHub
- URL: https://github.com/bratergit/brazilstocks
- Owner: bratergit
- License: unlicense
- Created: 2025-10-02T13:35:48.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-10-02T13:44:49.000Z (4 months ago)
- Last Synced: 2025-10-02T15:26:31.461Z (4 months ago)
- Topics: b3, bovespa, bovespa-stocks, hacktoberfest, hacktoberfest-accepted, stocks, stocks-api
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 0
- Forks: 5
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 📈 Brazilian Financial Markets Toolkit
A Hacktoberfest-friendly open-source project focused on data analysis, quantitative finance, and automated trading strategies for the Brazilian stock market (B3) and cryptocurrencies.
## 🌟 Project Scope
This repository aims to be a central hub for tools related to:
* **Brazilian Stock Market (B3):** Data acquisition, cleaning, and fundamental/technical analysis of Brazilian equities.
* **Interest Rate Calculation:** Tools for calculating and visualizing common financial metrics and interest rates (e.g., CDI, SELIC, compounded returns).
* **Web Scraping & Open Data:** Utilizing open-source data and web scraping techniques to gather non-traditional financial information.
* **Crypto Trading Bots:** Developing and backtesting automated trading strategies for major cryptocurrencies using Node.js and Python.
## 🛠️ Key Technologies
| Category | Technology | Purpose |
| :--- | :--- | :--- |
| **Data/Analysis** | Python | Primary language for data processing, analysis, and ML. |
| **Financial Data** | yfinance (Python) | Fetching market data (stocks, ETFs, indices). |
| **Web Scraping** | Python/Node.js Libraries | Extracting open data from public sources. |
| **Frontend/Viz** | Streamlit (Python) | Creating interactive dashboards and data visualization tools. |
| **Automation/Bots** | Node.js | Ideal for building fast, concurrent crypto trading bot components. |
| **Environment** | Docker / Docker Compose | Ensuring reproducible environments for all contributors. |
## 🖥️ Local Setup
Follow these steps to run the project locally:
1. **Clone the repository**
```bash
git clone https://github.com/bratergit/brazilstocks.git
cd brazilstocks
```
2. **Start the environment with Docker Compose**
```bash
docker-compose up
```
3. Access the app / services
- If it’s a web service, open your browser at http://localhost:PORT (replace PORT if necessary).
- Tip: Adjust instructions if the project needs any other setup (Python dependencies, Node.js packages, etc.).
**Step 3: Stage and Commit**
Once you save the README changes:
```bash
git add README.md
git commit -m "Add Local Setup section to README with clone and docker-compose instructions"
```
4. **Push the Branch**
```bash
git push origin add-local-setup-readme
```
5. **Open a Pull Request**
- Go to the repo on GitHub.
- You'll see Compare & Pull Request for your branch, click it.
- Title suggestion:
Docs: Add Local Setup section to README
- Description suggestion:
This PR adds a Local Setup section to README.md for easier onboarding of new contributors.
Instructions include cloning the repo and running docker-compose.
- Submit the PR and wait for review.
## 🤝 Contribution Guide
We welcome contributions for Hacktoberfest and beyond! Please read the following files to get started:
* [**CONTRIBUTING.md**](CONTRIBUTING.md) for contribution guidelines and setup.
* [**CODE_OF_CONDUCT.md**](CODE_OF_CONDUCT.md) for community standards.
## 📝 License
This project is licensed under the [MIT License](LICENSE) – see the LICENSE file for details.
Check the [**Issues**](https://github.com/bratergit/stocks/issues) section for tasks labeled **`hacktoberfest`** and **`good first issue`**.