{"id":15192056,"url":"https://github.com/gustavonav/exchange_extractor","last_synced_at":"2026-01-24T16:45:37.710Z","repository":{"id":253167482,"uuid":"842680468","full_name":"GustavoNav/exchange_extractor","owner":"GustavoNav","description":"Aplicação para criar um ambiente e executar pipelines de dados.","archived":false,"fork":false,"pushed_at":"2024-08-19T04:49:19.000Z","size":1478,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T16:47:42.334Z","etag":null,"topics":["airflow","docker","dockercompose","exchange","pipelines","postgresql","streamlit","webscraping"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GustavoNav.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-14T21:02:33.000Z","updated_at":"2024-08-19T04:49:22.000Z","dependencies_parsed_at":"2024-08-17T22:25:58.408Z","dependency_job_id":"bc6970b4-6434-4ab3-94aa-305dc5277aab","html_url":"https://github.com/GustavoNav/exchange_extractor","commit_stats":{"total_commits":24,"total_committers":2,"mean_commits":12.0,"dds":0.08333333333333337,"last_synced_commit":"8165fc6b1f90ea798a8307a03eaad1daf930b47b"},"previous_names":["gustavonav/exchange_extractor"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GustavoNav%2Fexchange_extractor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GustavoNav%2Fexchange_extractor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GustavoNav%2Fexchange_extractor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GustavoNav%2Fexchange_extractor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GustavoNav","download_url":"https://codeload.github.com/GustavoNav/exchange_extractor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254295866,"owners_count":22047154,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["airflow","docker","dockercompose","exchange","pipelines","postgresql","streamlit","webscraping"],"created_at":"2024-09-27T21:04:16.509Z","updated_at":"2026-01-24T16:45:37.677Z","avatar_url":"https://github.com/GustavoNav.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📊 **Extract-Exchange**\n\n## 🛠️ Sobre\n\nO **Extract-Exchange** é um projeto dedicado ao estudo de Engenharia de Dados. Ele fornece um ambiente robusto para coleta de dados por meio de APIs e Web Scraping, armazenamento dessas informações em um banco de dados PostgreSQL e exibição dos dados através de visualizações interativas. Utilizamos **Streamlit** para a demonstração das visualizações e **Airflow** para gerenciar e executar as pipelines.\n\nO projeto foi criado seguindo boas praticas de programação, sendo completamente modularizado, cada recurso pode funcionar independete do outro. \n\nPara testar o resultado no streamlit sem precisar instalar o repositório, acesse: [https://view-exchange-tnthxryusub5cwfncvyhfn.streamlit.app/](https://view-exchange-tnthxryusub5cwfncvyhfn.streamlit.app/)\n\nSiga as instruções para fazer o ambiente funcionar e se comunicar por completo.\n\n## 🏗️ Arquitetura\n\n![Imagem da Arquitetura](image.png)\n\n### data_extractor:\nAplicação responsável por fazer a coleta de dados. O requeriments.txt possui apenas as configurações necessária para essa parte funcionar individualmente, você pode executar de forma independente utilizando as funções disponíveis no run.py de cada um dos extractors:\n\n- general_information_extractor (Por Web Scraping)\n- historic_extractor (Utiliza a API)\n- real_time_extractor (Utiliza a API)\n\nO Dockerfile é para colocar a aplicação em um container (é essencial para funcionar com o docker-compose, caso tente executar separadamente, é preciso configurar um banco de dados, a conexão é feita utilizando sqlalchemy e pode ser ajustada em data_extractor/db , a injeção de dados é individual para cada extractor, e deve ser configurada no repository disponível em data_extractor/nome_do_extractor/db )\n\n#### Como os Dados São Coletados?\n\nOs dados foram coletados de 2 formas:\n- Por meio da API [yfinance](https://github.com/ranaroussi/yfinance) para coletar dados financeiros de empresas.\n\n- Por meio de web scraping, que é realizado com `requests` para obter o HTML de [InfoMoney](https://www.infomoney.com.br/) e, em seguida, são realizadas operações com Regex para extrair os dados das empresas.\n\n### data_visualize\nO data_visualize permite ter uma visualização do dados, utilizando streamlit. Os dados foram salvos no formato parquet, o repository permite coletar os dados atuais do banco de dados para carregar. O requeriments.txt possui as configurações para que esse módulo possa funcionar individualmente. \n\nJá tem 3 arquivos parquet salvos no repositório para visualização caso não queira puxar do banco de dados.\n\nPara executar o streamlit utilize:\n\n```\nstreamlit run ./data_visualize/main.py\n```\n\nPor fim acesse a URL disponibilizada no terminal.\n\n\n## 🔧 Configuração\n\n### 0. Banco de Dados\n\nO banco de dados é criado automaticamente ao executar o Docker Compose e é dividido em 3 tabelas:\n\n- **tb_historic**: Armazena dados financeiros da empresa ao longo do tempo. \n- **tb_general_financials**: Armazena dados gerais da empresa ao longo do tempo. \n- **tb_real_time**: Armazena dados financeiros da empresa ao longo do dia, com intervalo de 1 minuto.  \n\n```sql\nCREATE TABLE IF NOT EXISTS tb_historic (\n    id SERIAL PRIMARY KEY,\n    date_information TIMESTAMP WITH TIME ZONE,\n    open NUMERIC(14, 6),\n    high NUMERIC(14, 6),\n    low NUMERIC(14, 6),\n    close NUMERIC(14, 6),\n    volume BIGINT,\n    dividends NUMERIC(14, 6),\n    stock_splits NUMERIC(14, 6),\n    company_code VARCHAR(10),\n    CONSTRAINT unique_historic UNIQUE (date_information, open, high, low, close, volume, dividends, stock_splits, company_code)\n);\n\nCREATE TABLE IF NOT EXISTS tb_general_financials (\n    id SERIAL PRIMARY KEY,\n    company_code VARCHAR(10) NOT NULL,\n    sector VARCHAR(50),\n    net_sales NUMERIC(15, 2),\n    net_income NUMERIC(15, 2),\n    net_margin NUMERIC(5, 2),\n    ebitda NUMERIC(15, 2),\n    ebitda_margin NUMERIC(5, 2),\n    total_assets NUMERIC(15, 2),\n    gross_debt NUMERIC(15, 2),\n    equity NUMERIC(15, 2),\n    pe_ratio NUMERIC(5, 2),\n    CONSTRAINT unique_company_code UNIQUE (company_code)\n);\n\nCREATE TABLE IF NOT EXISTS tb_real_time(\n    id SERIAL PRIMARY KEY,\n    company_code VARCHAR(10) NOT NULL,\n    date_information TIMESTAMP,\n    open NUMERIC(14, 6),\n    high NUMERIC(14, 6),\n    low NUMERIC(14, 6),\n    close NUMERIC(14, 6),\n    CONSTRAINT unique_real_time UNIQUE (company_code, date_information, open, high, low, close)\n);\n```\n### 1. Configuração do Ambiente\nÉ necessário Python 3.10.12 | Docker version 24.0.7 | Docker Compose version v2.29.1 (Pode não funcionar com outras versões)\n\nPrimeiro clone o repositório:\n```\ngit clone https://github.com/GustavoNav/exchange_extractor\n```\n\nNa raiz do projeto, execute o seguinte comando para criar e iniciar as imagens e containers Docker:\n```\ndocker-compose up --build\n```\n\nCom isso, os serviços data_extractor e PostgreSQL estarão funcionando. É possível executar as pipelines manualmente com os seguintes comandos:\n```\ndocker-compose run --rm app historic_extractor/run.py \u003cCÓDIGO DA EMPRESA\u003e\n\n# Exemplo: Coleta dados da VALE3.SA para a tabela tb_historic\ndocker-compose run --rm app historic_extractor/run.py VALE3.SA\n```\n\n```\ndocker-compose run --rm app real_time_extractor/run.py \u003cCÓDIGO DA EMPRESA\u003e\n\n# Exemplo: Coleta dados da VALE3.SA para a tabela tb_real_time\ndocker-compose run --rm app real_time_extractor/run.py VALE3.SA\n```\n\n```\ndocker-compose run --rm app general_information_extractor/run.py \u003cLINK INFOMONEY DA EMPRESA\u003e \u003cCÓDIGO DA EMPRESA\u003e\n# Exemplo: Coleta dados da VALE3.SA para a tabela tb_general_financials\ndocker-compose run --rm app general_information_extractor/run.py https://www.infomoney.com.br/cotacoes/b3/acao/vale-vale3/ VALE3.SA\n```\n\n### 2. Configuração do Airflow\n\nO Airflow é configurado localmente com o airflowctl. Para instalá-lo, para instalar, execute:\n\n```\npip install airflowctl\n```\n\n```\nairflowctl init airflow_project --build-start\n```\n\nEm seguida, mova o conteúdo do diretório dags-temp da raiz para o diretório airflow_project/dags:\n\n- general_etl.py\n- historic_etl.py\n- real_time_etl.py\n\nPor fim, acesse localhost:8080, faça login com o usuário e senha criados pelo Airflow (informados no terminal), e ative as DAGs para começar a execução.\n\nCaso as Dags não apareçam, encerre o airflow para iniciar novamente:\n\n```\nairflowctl start airflow_project/\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgustavonav%2Fexchange_extractor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgustavonav%2Fexchange_extractor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgustavonav%2Fexchange_extractor/lists"}