feat: enhance package with improved typing, documentation, and automation

Author: DiogoRibeiro7

.editorconfig

@@ -0,0 +1,35 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+# Python files
+[*.py]
+indent_style = space
+indent_size = 4
+max_line_length = 100
+
+# YAML files
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+# JSON files
+[*.json]
+indent_style = space
+indent_size = 2
+
+# Markdown files
+[*.md]
+trim_trailing_whitespace = false
+
+# Makefile
+[Makefile]
+indent_style = tab

.github/workflows/code-coverage.yml

@@ -7,6 +7,10 @@ on:
     branches: [ "main" ]
   workflow_dispatch:
 
+# Add permissions block here
+permissions:
+  contents: write  # Needed to update the README.md file
+  
 jobs:
   coverage:
     runs-on: ubuntu-latest

.github/workflows/security-scan.yml

@@ -0,0 +1,52 @@
+name: Security Scan
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '0 8 * * 1'  # Run at 8:00 UTC every Monday
+  workflow_dispatch:
+
+jobs:
+  bandit:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install bandit
+          
+      - name: Run bandit
+        run: |
+          bandit -r src/ -c pyproject.toml -f json -o bandit-results.json
+          
+      - name: Upload bandit results
+        uses: actions/upload-artifact@v4
+        with:
+          name: bandit-results
+          path: bandit-results.json
+          
+  trivy:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Run Trivy vulnerability scanner
+        uses: aquasecurity/trivy-action@master
+        with:
+          scan-type: 'fs'
+          format: 'table'
+          exit-code: '1'
+          ignore-unfixed: true
+          severity: 'CRITICAL,HIGH'

.github/workflows/style-check.yml

@@ -0,0 +1,41 @@
+name: Style Check
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+          
+      - name: Install dependencies
+        run: |
+          poetry install
+          
+      - name: Run black
+        run: |
+          poetry run black --check --diff src tests
+          
+      - name: Run isort
+        run: |
+          poetry run isort --check-only --diff src tests
+          
+      - name: Run ruff
+        run: |
+          poetry run ruff check src tests

.pre-commit-config.yaml

@@ -7,16 +7,46 @@ repos:
       - id: check-yaml
       - id: check-toml
       - id: check-added-large-files
+      - id: check-ast
+      - id: check-json
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: mixed-line-ending
+        args: [--fix=lf]
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: [--profile, black, --filter-files]
+
+  - repo: https://github.com/psf/black
+    rev: 24.2.0
+    hooks:
+      - id: black
+        args: [--line-length=100]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.3.0
     hooks:
       - id: ruff
         args: [--fix]
-      - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.9.0
     hooks:
       - id: mypy
         additional_dependencies: [types-all]
+
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.7
+    hooks:
+      - id: bandit
+        args: ["-c", "pyproject.toml"]
+        exclude: "tests/"
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.1
+    hooks:
+      - id: pyupgrade
+        args: [--py310-plus]

Makefile

@@ -1,26 +1,40 @@
-.PHONY: help install format lint type-check test test-cov clean build publish-test publish
+.PHONY: help install format lint type-check test test-cov clean build publish-test publish setup dev-install security docs tox
 
 help:
 	@echo "Available commands:"
 	@echo "  make install      Install the package and dependencies"
-	@echo "  make format       Format code with ruff"
+	@echo "  make dev-install  Install the package and dev dependencies"
+	@echo "  make setup        Install pre-commit hooks and dev dependencies"
+	@echo "  make format       Format code with black, isort, and ruff"
 	@echo "  make lint         Lint code with ruff"
 	@echo "  make type-check   Type check with mypy"
 	@echo "  make test         Run tests"
 	@echo "  make test-cov     Run tests with coverage"
+	@echo "  make tox          Run tests in multiple Python environments"
+	@echo "  make security     Run security checks with bandit"
+	@echo "  make docs         Generate documentation"
 	@echo "  make clean        Remove build artifacts"
 	@echo "  make build        Build package"
 	@echo "  make publish-test Publish to TestPyPI"
 	@echo "  make publish      Publish to PyPI"
 
 install:
+	poetry install --no-dev
+
+dev-install:
+	poetry install
+
+setup:
 	poetry install
+	pre-commit install
 
 format:
-	poetry run ruff format .
+	poetry run black src tests
+	poetry run isort src tests
+	poetry run ruff format src tests
 
 lint:
-	poetry run ruff check .
+	poetry run ruff check src tests
 
 type-check:
 	poetry run mypy src tests
@@ -31,6 +45,15 @@ test:
 test-cov:
 	poetry run pytest --cov=my_python_package --cov-report=term-missing
 
+tox:
+	poetry run tox
+
+security:
+	poetry run bandit -r src/
+
+docs:
+	poetry run python scripts/generate_docs.py
+
 clean:
 	rm -rf build/
 	rm -rf dist/