{"id":22123307,"url":"https://github.com/leotgo/brsp-stock-alert","last_synced_at":"2025-07-11T01:40:03.615Z","repository":{"id":212507222,"uuid":"731617111","full_name":"leotgo/brsp-stock-alert","owner":"leotgo","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-14T15:24:35.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T13:08:30.899Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","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/leotgo.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}},"created_at":"2023-12-14T13:36:21.000Z","updated_at":"2023-12-14T15:06:09.000Z","dependencies_parsed_at":"2023-12-14T16:47:01.212Z","dependency_job_id":null,"html_url":"https://github.com/leotgo/brsp-stock-alert","commit_stats":null,"previous_names":["leotgo/brsp-stock-alert"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leotgo%2Fbrsp-stock-alert","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leotgo%2Fbrsp-stock-alert/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leotgo%2Fbrsp-stock-alert/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leotgo%2Fbrsp-stock-alert/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leotgo","download_url":"https://codeload.github.com/leotgo/brsp-stock-alert/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245226868,"owners_count":20580761,"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":[],"created_at":"2024-12-01T15:31:49.038Z","updated_at":"2025-03-24T07:28:34.024Z","avatar_url":"https://github.com/leotgo.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BRSP_StockAlert\r\n\r\nO projeto **BRSP_StockAlert** contempla a implementação de uma aplicação de linha de comando que realiza o monitoramento do valor de algum ativo determinado pelo usuário, e envia alertas por email quando o ativo ultrapassa valores de compra e venda - também estipulados pelo usuário.\r\n\r\n## Como Usar\r\n\r\nPara utilizar a aplicação, basta executar pela linha de comando utilizando o seguinte formato:\r\n\r\n```cmd\r\n\u003e BRSP_StockAlert \u003cticker_ativo\u003e \u003cpreco_compra\u003e \u003cpreco_venda\u003e\r\n```\r\n\r\nOnde os parâmetros representam, respectivamente:\r\n\r\n* `\u003cticker_ativo\u003e`: o código (ticker) do ativo a ser monitorado. Por exemplo: `PETR4`;\r\n* `\u003cpreco_compra\u003e`: o preço sugerido de compra informado pelo usuário em formato decimal (`nn.nn`), onde caso o ativo esteja com valor atual **menor** do que `\u003cpreco_compra\u003e`, um email será enviado sugerindo a compra do ativo em questão;\r\n* `\u003cpreco_venda\u003e`: o preço sugerido de venda informado pelo usuário em formato decimal (`nn.nn`), onde caso o ativo esteja com valor atual **maior** do que `\u003cpreco_venda\u003e`, um email será enviado sugerindo a venda do ativo em questão.\r\n\r\nDesta forma, um exemplo de execução válida da aplicação por linha de comando seria:\r\n\r\n```cmd\r\n\u003e BRSP_StockAlert PETR4 23.37 34.05\r\n```\r\n\r\n## Requerimentos\r\n\r\nPara executar a aplicação, é necessário que o usuário tenha instalada a versão mais recente da plataforma **.NET**, disponível em: \u003chttps://dotnet.microsoft.com/en-us/download/dotnet\u003e\r\n\r\nAlém disso, é necessário garantir que os arquivos de configuração necessários estão presentes junto aos binários da aplicação. Dentro da pasta `config/`, devem existir os arquivos `settings.ini`, `auth-brapi.ini` e `smtp-credentials.ini`.\r\n\r\nDesta forma, a estrutura do diretório que conterá o binário da aplicação deve seguir a seguinte organização:\r\n\r\n```text\r\nconfig/\r\n    auth-brapi.ini\r\n    settings.ini\r\n    smtp-credentials.ini\r\nBRSP_StockAlert.exe\r\nBRSP_StockAlert.dll\r\nIniFileParser.dll\r\nNewtonsoft.Json.dll\r\n```\r\n\r\nO arquivo `settings.ini` com valores de exemplo pré-configurados pode ser observado dentro pasta `config/` deste repositório.\r\n\r\n### Sobre `auth-brapi.ini` e `smtp-credentials.ini`\r\n\r\nOs arquivos `auth-brapi.ini` e `smtp-credentials.ini` não são disponibilizados neste repositório ou distribuídos abertamente. Desta forma, é necessário que o usuário da aplicação realize a própria criação e configuração correta de tais arquivos.\r\n\r\nO arquivo `auth-brapi.ini` contém dados de autenticação para a API provedora de dados da B3, e deve seguir o seguinte formato:\r\n\r\n```ini\r\n[AUTH]\r\n; BRAPI-Token: Token de acesso da API BRAPI\r\nBRAPI-Token = \u003cseu_token_de_acesso_da_api_brapi\u003e\r\n```\r\n\r\nO arquivo `smtp-credentials.ini` contém dados relativos à autenticação do email fonte que enviará os alertas ao usuário destino, e deve seguir o seguinte formato:\r\n\r\n```ini\r\n[CREDENTIALS]\r\n; Username: Usuário/email fonte dos alertas.\r\nUsername = \u003cseu_username_smtp\u003e\r\n; Password: Senha de acesso do usuário fonte dos alertas.\r\nPassword = \u003csua_senha_de_acesso_smtp\u003e\r\n```\r\n\r\n## Como Executar o Projeto\r\n\r\nPara a execução da aplicação contida neste projeto, é possível escolher uma dentre as seguintes formas:\r\n\r\n* Utilizar a IDE de sua preferência para abrir o projeto, por exemplo: *Visual Studio Code*, *Visual Studio*;\r\n* Utilizar o comando `dotnet run \u003cparametros\u003e` pela linha de comando para executar a aplicação a partir da pasta raiz do projeto. Por exemplo: `dotnet run PETR4 23.37 34.05`\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleotgo%2Fbrsp-stock-alert","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleotgo%2Fbrsp-stock-alert","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleotgo%2Fbrsp-stock-alert/lists"}