Add static check (#231)

* Add static check
* Update .github/workflows/test.yml

.github/workflows/main.yml

@@ -25,13 +25,9 @@ jobs:
         venv/bin/python3 -m pip install tox-gh-actions
       env:
         SLUGIFY_USES_TEXT_UNIDECODE: yes
-    - name: Check formatting with black
-      run: make fmt-check
-    - name: Lint with pylint
-      run: make lint
     - name: Test with tox
       run: make test
-    - name: Upload coverage to Codecov  
+    - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v3
       with:
         token: ${{secrets.CODECOV_TOKEN}}

.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: test
+
+on:
+  push: # Run on pushes to the default branch
+    branches: [main]
+  pull_request_target: # Also run on pull requests originated from forks
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  Authorize:
+    environment: ${{ github.event_name == 'pull_request_target' &&
+      github.event.pull_request.head.repo.full_name != github.repository &&
+      'external' || 'internal' }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: true
+
+  Static-Check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.ref }}
+
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.12"
+          architecture: "x64"
+
+      - run: pip3 install hatch
+      - run: hatch run tests.py3.12-2.10:static-check

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+        args:
+          - --unsafe
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: pretty-format-json
+        args: [ "--autofix" ]
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+        args: [ "--config", "./pyproject.toml" ]

Makefile

@@ -27,20 +27,6 @@ clean: ## Removes build and test artifacts
 	@find . -name '*~' -exec rm -f {} +
 	@find . -name '__pycache__' -exec rm -rf {} +
 
-.PHONY: fmt
-fmt: venv ## Formats all files with black
-	@echo "==> Formatting with Black"
-	@${PYTHON} -m black dagfactory
-
-.PHONY: fmt-check
-fmt-check: venv ## Checks files were formatted with black
-	@echo "==> Formatting with Black"
-	@${PYTHON} -m black --check dagfactory
-
-.PHONY: lint
-lint: venv ## Lint code with pylint
-	@${PYTHON} -m pylint dagfactory
-
 .PHONY: test
 test: venv ## Runs unit tests
 	@${PYTHON} -m tox
@@ -57,4 +43,4 @@ docker-run: docker-build ## Runs local Airflow for testing
 
 .PHONY: docker-stop
 docker-stop: ## Stop Docker container
-	@docker stop dag_factory; docker rm dag_factory
+	@docker stop dag_factory; docker rm dag_factory

dagfactory/__init__.py

@@ -1,3 +1,8 @@
 """Modules and methods to export for easier access"""
 
 from .dagfactory import DagFactory, load_yaml_dags
+
+__all__ = [
+    "DagFactory",
+    "load_yaml_dags",
+]