Merge pull request #1 from includeamin/init

feat: add first version with green tests

Author: Amin Jamal

.editorconfig

@@ -0,0 +1,19 @@
+# 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
+
+# Apply unified ruleset for these file endings
+[*.{json,yml,yaml,jsonc,jsonschema}]
+indent_style = space
+indent_size = 2
+
+# Tab indentation
+[Makefile]
+indent_style = tab

.github/workflows/quality.yaml

@@ -0,0 +1,32 @@
+name: Lint and Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ci:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.11", "3.12", "3.13"]
+        poetry-version: ["latest"]
+        os: [ubuntu-22.04, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run image
+        uses: abatilo/actions-poetry@v3
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: install dependencies
+        run: poetry install
+      - name: lint
+        run: make lint
+      - name: test
+        run: make test

.github/workflows/release.yml

@@ -0,0 +1,55 @@
+name: Tag and Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  tag-and-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for full git history
+
+      - name: Set up Git user
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "actions@github.com"
+
+      - name: Install git-cliff
+        run: |
+          curl -sSL https://github.com/orhun/git-cliff/releases/latest/download/git-cliff-linux-x86_64.tar.gz | tar -xz
+          sudo mv git-cliff /usr/local/bin/
+
+      - name: Get latest tag
+        id: get_tag
+        run: |
+          latest_tag=$(git describe --tags --abbrev=0)
+          echo "latest_tag=$latest_tag" >> $GITHUB_OUTPUT
+
+      - name: Bump version and create new tag
+        id: new_tag
+        run: |
+          # Example: bump patch version (customize as needed)
+          IFS='.' read -r major minor patch <<< "${{ steps.get_tag.outputs.latest_tag }}"
+          new_tag="v$major.$minor.$((patch + 1))"
+          git tag "$new_tag"
+          git push origin "$new_tag"
+          echo "new_tag=$new_tag" >> $GITHUB_OUTPUT
+
+      - name: Generate changelog
+        run: |
+          git-cliff -c cliff.toml -t ${{ steps.new_tag.outputs.new_tag }} -o CHANGELOG.md
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: ${{ steps.new_tag.outputs.new_tag }}
+          name: Release ${{ steps.new_tag.outputs.new_tag }}
+          body_path: CHANGELOG.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

.pre-commit-config.yaml

@@ -0,0 +1,63 @@
+repos:
+  - repo: local
+    # Pre-built hooks for all these "local" checks are available as well. We rather
+    # define our own to ensure their version matches the one in pyproject.toml/poetry.lock
+    hooks:
+      # python code linters
+      - id: ruff-format
+        name: ruff-format
+        language: system
+        entry: poetry run ruff format
+        types: [ python ]
+      - id: ruff-check
+        name: ruff-check
+        language: system
+        entry: poetry run ruff check
+        types: [ python ]
+        args: [ --exit-non-zero-on-fix ]
+        files: .
+      - id: mypy
+        name: mypy
+        language: system
+        entry: poetry run mypy
+        types: [ python ]
+      # poetry checks
+      - id: poetry-check
+        name: poetry-check
+        language: system
+        entry: poetry check
+        files: ^pyproject.toml$
+        pass_filenames: false
+      - id: poetry-check-lock
+        name: poetry-check-lock
+        entry: poetry check
+        language: system
+        pass_filenames: false
+        args: [ "--lock" ]
+        files: |
+          (?x)^(
+              pyproject.toml|
+              poetry.lock
+          )$
+
+  # common checks that aren't supported by the linters we use in this service
+  # i.e. in a project that uses prettier, you don't need the json checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-toml
+      - id: check-xml
+
+  - repo: https://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.90.0
+    hooks:
+      - id: terraform_fmt
+      - id: terraform_validate  # this step might take a minute the first time it runs
+
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.2.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [ commit-msg ]

Makefile

@@ -0,0 +1,20 @@
+# ------------------------------------------------------
+# HELP
+# ------------------------------------------------------
+.PHONY: help
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+# ------------------------------------------------------
+# LOCAL COMMANDS
+# ------------------------------------------------------
+.PHONY: test_unit
+test: ## Run unit tests
+	@poetry run pytest ./tests
+
+
+# this linter just lints src/services/notification/ and tests folders.
+# it should gradually covers all other parts of the code as soon all errors have been fixed
+.PHONY: lint
+lint: ## Run linters with auto-fix.
+	@poetry run pre-commit run --all-files

README.md

@@ -1,2 +1,51 @@
 # diff
-A library to calculate structured data
+
+Diff is a library to calculate deltas between structured data.
+
+## Features
+
+- Calculate detlas
+- Rebuild via deltas
+
+## Supported Formats
+
+- [x] JSON
+- [ ] YAML
+- [ ] XML
+- [ ] TOML
+
+## Usage
+
+### Diff
+
+```python
+import diff
+
+old = {"name": "David"}
+new = {"name": "Alex"}
+deltas = diff.diff(new=new, old=old)
+
+for delta in deltas:
+    print(delta)
+
+```
+
+Output
+
+```text
+Operation(op='modified', path='$.name', new_value='Alex', old_value='David')
+```
+
+### Rebuild
+
+```python
+import diff
+
+old = {"name": "David"}
+new = {"name": "Alex"}
+deltas = diff.diff(new=new, old=old)
+
+rebuild_new = diff.patch(base=old, deltas=deltas)
+
+assert rebuild_new == old
+```

mypy.ini

@@ -0,0 +1,25 @@
+# docs: https://mypy.readthedocs.io/en/stable/config_file.html
+[mypy]
+python_version = 3.11
+allow_redefinition = False
+check_untyped_defs = True
+disallow_untyped_decorators = True
+disallow_any_explicit = False
+disallow_any_generics = False
+disallow_untyped_calls = True
+ignore_errors = False
+ignore_missing_imports = True
+implicit_reexport = False
+strict_optional = True
+strict_equality = True
+show_traceback = True
+no_implicit_optional = True
+warn_unused_ignores = True
+warn_redundant_casts = True
+warn_unused_configs = True
+warn_unreachable = True
+warn_no_return = True
+; plugins =
+exclude =
+    build
+    .venv