Welcome to the Documentation!

Precise, fast, and reliable data analysis

python jupyter sphinx

Overview

A project that automatically gathers, processes, and analyzes investment fund data.

The objective is to provide a solid foundation for historical analysis, data visualization, and investment simulations.

Prerequisites

  • Required software:

    Note

    It is recommended to use Visual Studio Code, as it provides excellent support for Jupyter Notebooks.

  • Access to the project

    Clone the repository:

    git clone https://github.com/NicolasChirazawa/automacao-cotas-investimento.git

    Or download the .zip file from GitHub.

  • Install dependencies

    The project includes a requirements.txt file in the root directory containing all required dependencies.

    pip install -r requirements.txt

Next Steps

Getting Started

  • JSON Configuration

    • Learn how to configure the project

    • Understand the CONFIG key

    • Understand the DIR key

    • Understand the INVESTMENTS key

    • Understand the CHARTS key

    • Understand the REDEEM key

  • Project Flow

    • Understand the project features

    • Learn how features communicate with each other

    • Understand the overall project structure

System Modules

  • Spreadsheet

    • Learn how to use the spreadsheet feature

    • Download and process only the data relevant to you

    • Access available CVM and CDI data

  • Charts

    • Learn how to use the charts feature

    • Generate visualizations to improve data readability

  • Redeem

    • Learn how to simulate investments

Technical Aspects

  • Functions

    • Understand which functions are used

  • Classes

    • Understand how and why the system uses these classes

Questions / Comments

If you have questions about this project, feel free to open an issue on GitHub: here