Merge pull request #2 from thobiast/dev

Dev

Author: thobiast

.github/workflows/build.yml

@@ -1,47 +1,23 @@
 name: build
-on:
-  pull_request:
-  push:
-    branches: [main]
+on: [push]
+
 jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: '3.x'
-      - name: Display Python version
-        run: python -c "import sys; print(sys.version)"
-      - name: Install tox
-        run: pip install --upgrade tox black
-      - name: Run tox flake8
-        run: tox -e flake8
-      - name: Run tox black
-        run: tox -e black
-  test:
-    needs: lint
+  build:
+
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ["3.10", "3.11", "3.12"]
+
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Display Python version
         run: python -c "import sys; print(sys.version)"
-      - name: install tox
-        run: python -m pip install --upgrade tox virtualenv setuptools pip
-      - name: run tox tests
-        run: tox -e py
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
-        with:
-          file: ./coverage.xml
-          flags: unittests
-          env_vars: OS,PYTHON
-          fail_ci_if_error: true
+      - name: Install dependencies
+        run: python -m pip install --upgrade pre-commit tox virtualenv setuptools pip
+      - name: run tox
+        run: tox

.github/workflows/publish.yml

@@ -6,9 +6,9 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
       - name: Install dependencies

.pre-commit-config.yaml

@@ -0,0 +1,42 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: trailing-whitespace
+    -   id: debug-statements
+
+-   repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+    -   id: black
+        args: ["--diff", "--check"]
+
+-   repo: https://github.com/PyCQA/bandit
+    rev: 1.8.3
+    hooks:
+    -   id: bandit
+        exclude: ^tests/
+
+-   repo: https://github.com/PyCQA/flake8
+    rev: 7.1.2
+    hooks:
+    -   id: flake8
+        additional_dependencies: [flake8-bugbear, pep8-naming]
+        args: [--max-line-length=131]
+
+-   repo: https://github.com/PyCQA/isort
+    rev: 6.0.0
+    hooks:
+    -   id: isort
+
+-   repo: https://github.com/PyCQA/pylint
+    rev: v3.3.4
+    hooks:
+    -   id: pylint
+        args: ["--disable=W0601"]
+        additional_dependencies:
+            - "requests"
+            - "pandas"
+            - "pytest"

README.md

@@ -1,8 +1,7 @@
-# magicformulabr - Script que implementa a magic formula de Joel Greenblatt para empresas listadas na Bovespa.
+# magicformulabr - Script que implementa a magic formula de Joel Greenblatt para classificar empresas listadas na Bovespa.
 
-![build](https://github.com/thobiast/magicformulabr/workflows/build/badge.svg)
+[![Build and Test](https://github.com/thobiast/magicformulabr/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/thobiast/magicformulabr/actions/workflows/build.yml)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/magicformulabr)
-[![codecov](https://codecov.io/gh/thobiast/magicformulabr/branch/main/graph/badge.svg)](https://codecov.io/gh/thobiast/magicformulabr)
 [![GitHub License](https://img.shields.io/github/license/thobiast/magicformulabr)](https://github.com/thobiast/magicformulabr/blob/main/LICENSE)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
@@ -20,9 +19,12 @@ pip install magicformulabr
 
 ## Uso
 
+O magicformulabr armazena os dados baixados em um arquivo local "*data_cache.json*" por 24 horas
+para evitar requisições desnecessárias. Use `--force-update` para atualizar os dados.
+
 ```bash
 $ magicformulabr -h
-usage: magicformulabr [-h] [-d] [-v] [-m {1,2,3}] [-t TOP]
+usage: magicformulabr [-h] [-d] [-v] [-m {1,2,3}] [-t TOP] [--force-update]
 
 Gera rank de acoes usando a magic formula
 
@@ -33,6 +35,7 @@ optional arguments:
   -m {1,2,3}, --method {1,2,3}
                         Campos usados para o calculo da magic formula
   -t TOP, --top TOP     Numero de empresas para mostrar no rank
+  --force-update        Forca a atualizacao do cache
 
     Methods disponiveis:
         1 - P/L e ROE

pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "magicformulabr"
+description = "Magic Formula script for companies listed at Bovespa."
+readme = "README.md"
+license = {file = "LICENSE"}
+dynamic = ["version", "dependencies"]
+requires-python = ">=3.7"
+authors = [
+    {name = "Thobias Salazar Trevisan"},
+]
+
+[project.scripts]
+magicformulabr = "magicformulabr.main:main"
+
+[project.urls]
+"Homepage" = "https://github.com/thobiast/magicformulabr"
+"Source" = "https://github.com/thobiast/magicformulabr"
+
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+packages = ["magicformulabr"]
+
+[tool.setuptools.dynamic]
+version = {attr = "magicformulabr.__version__"}
+dependencies = {file = ["requirements.txt"]}