Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leotgo/brsp-stock-alert
https://github.com/leotgo/brsp-stock-alert
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/leotgo/brsp-stock-alert
- Owner: leotgo
- Created: 2023-12-14T13:36:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-14T15:24:35.000Z (about 1 year ago)
- Last Synced: 2023-12-15T16:39:54.494Z (about 1 year ago)
- Language: C#
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BRSP_StockAlert
O 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.
## Como Usar
Para utilizar a aplicação, basta executar pela linha de comando utilizando o seguinte formato:
```cmd
> BRSP_StockAlert
```
Onde os parâmetros representam, respectivamente:
* ``: o código (ticker) do ativo a ser monitorado. Por exemplo: `PETR4`;
* ``: 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 ``, um email será enviado sugerindo a compra do ativo em questão;
* ``: 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 ``, um email será enviado sugerindo a venda do ativo em questão.
Desta forma, um exemplo de execução válida da aplicação por linha de comando seria:
```cmd
> BRSP_StockAlert PETR4 23.37 34.05
```
## Requerimentos
Para executar a aplicação, é necessário que o usuário tenha instalada a versão mais recente da plataforma **.NET**, disponível em:
Alé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`.
Desta forma, a estrutura do diretório que conterá o binário da aplicação deve seguir a seguinte organização:
```text
config/
auth-brapi.ini
settings.ini
smtp-credentials.ini
BRSP_StockAlert.exe
BRSP_StockAlert.dll
IniFileParser.dll
Newtonsoft.Json.dll
```
O arquivo `settings.ini` com valores de exemplo pré-configurados pode ser observado dentro pasta `config/` deste repositório.
### Sobre `auth-brapi.ini` e `smtp-credentials.ini`
Os 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.
O arquivo `auth-brapi.ini` contém dados de autenticação para a API provedora de dados da B3, e deve seguir o seguinte formato:
```ini
[AUTH]
; BRAPI-Token: Token de acesso da API BRAPI
BRAPI-Token =
```
O 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:
```ini
[CREDENTIALS]
; Username: Usuário/email fonte dos alertas.
Username =
; Password: Senha de acesso do usuário fonte dos alertas.
Password =
```
## Como Executar o Projeto
Para a execução da aplicação contida neste projeto, é possível escolher uma dentre as seguintes formas:
* Utilizar a IDE de sua preferência para abrir o projeto, por exemplo: *Visual Studio Code*, *Visual Studio*;
* Utilizar o comando `dotnet run ` 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`