Initial commit

AndreuCodina · AndreuCodina · commit 4e84c80cfa54 · 2024-10-21T22:14:54.000+02:00
diff --git a/.github/FUNDING.yaml b/.github/FUNDING.yaml
@@ -0,0 +1 @@
+github: AndreuCodina
diff --git a/.github/workflows/pull_request.yaml b/.github/workflows/pull_request.yaml
@@ -0,0 +1,34 @@
+name: Pull request
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  continous-integration:
+    runs-on: ubuntu-latest
+    env:
+      UV_NO_SYNC: 1
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.4.25"
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install Python packages
+        run: uv sync --locked
+        shell: bash
+
+      - name: Pre-commit
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --all-files
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+.venv/
+.ruff_cache/
+.pytest_cache/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,31 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-linter
+        name: Linter
+        entry: uv run -- ruff check
+        language: system
+        types: [python]
+        fail_fast: true
+
+      - id: ruff-formatter
+        name: Formatter
+        entry: uv run -- ruff format --diff
+        language: system
+        types: [python]
+        fail_fast: true
+
+      - id: pyright
+        name: Type checker
+        entry: uv run -- pyright
+        language: system
+        types: [python]
+        fail_fast: true
+
+      - id: unit-tests
+        name: Unit tests
+        entry: uv run -- pytest -m unit
+        language: system
+        types: [python]
+        fail_fast: true
+        pass_filenames: false
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.12
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,18 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "api",
+      "type": "debugpy",
+      "request": "launch",
+      "program": ".venv/bin/fastapi",
+      "args": [
+        "dev",
+        "api/src/api/main.py"
+      ],
+      "console": "integratedTerminal",
+      "justMyCode": false,
+      "preLaunchTask": "pre-commit-install"
+    }
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,28 @@
+{
+    "files.associations": {
+        "*.py": "python"
+    },
+    "editor.codeActionsOnSave": {
+        "source.fixAll": "always",
+        "source.organizeImports": "always"
+    },
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "[ipynb]": {
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "python.defaultInterpreterPath": ".venv/bin/python",
+    "python.languageServer": "Pylance",
+    "python.analysis.autoSearchPaths": true,
+    "python.analysis.autoImportCompletions": true,
+    "python.testing.pytestEnabled": true,
+    "notebook.formatOnSave.enabled": true,
+    "notebook.formatOnCellExecution": true,
+    "notebook.codeActionsOnSave": {
+        "notebook.source.fixAll": "explicit",
+        "notebook.source.organizeImports": "explicit"
+    },
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,15 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+      {
+        "label": "pre-commit-install",
+        "type": "shell",
+        "command": "uv",
+        "args": [
+          "run",
+          "pre-commit",
+          "install"
+        ]
+      }
+    ]
+  }
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Andreu Codina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,2 @@
+- [Projects](docs/projects.md)
+- [Pre-commit](docs/pre-commit.md)
diff --git a/api/pyproject.toml b/api/pyproject.toml
@@ -0,0 +1,8 @@
+[project]
+name = "api"
+version = "0.1.0"
+dependencies = []
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
diff --git a/api/src/api/__init__.py b/api/src/api/__init__.py
diff --git a/api/src/api/api_printer.py b/api/src/api/api_printer.py
@@ -0,0 +1,3 @@
+class ApiPrinter:
+    def print(self) -> None:
+        print("API printer")
diff --git a/api/src/api/main.py b/api/src/api/main.py
@@ -0,0 +1,11 @@
+from fastapi import FastAPI
+
+from domain.domain_printer import DomainPrinter
+
+app = FastAPI()
+
+
+@app.get("/")
+async def root() -> str:
+    DomainPrinter().print()
+    return "Hello"
diff --git a/database/1.sql b/database/1.sql
diff --git a/docs/pre-commit.md b/docs/pre-commit.md
@@ -0,0 +1,7 @@
+## Pre-commit
+
+```bash
+uv run pre-commit install
+
+uv run pre-commit run --all-files
+```
diff --git a/docs/projects.md b/docs/projects.md
@@ -0,0 +1,13 @@
+# Projects
+
+## API
+
+RESTful API.
+
+```bash
+uv run --directory api/src/api -- fastapi dev main.py
+```
+
+# Transcriber
+
+Audio transcriber reading from a queue.
diff --git a/domain/pyproject.toml b/domain/pyproject.toml
@@ -0,0 +1,8 @@
+[project]
+name = "domain"
+version = "0.1.0"
+dependencies = []
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
diff --git a/domain/src/domain/__init__.py b/domain/src/domain/__init__.py
@@ -0,0 +1,2 @@
+def hello() -> str:
+    return "Hello from domain!"
diff --git a/domain/src/domain/domain_printer.py b/domain/src/domain/domain_printer.py
@@ -0,0 +1,3 @@
+class DomainPrinter:
+    def print(self) -> None:
+        print("Domain printer")
diff --git a/domain/src/domain/product.py b/domain/src/domain/product.py
@@ -0,0 +1,15 @@
+from typing import Optional
+
+from sqlmodel import (
+    Field,  # type: ignore
+    SQLModel,
+)
+
+
+class Product(SQLModel, table=True):
+    __tablename__ = "product"  # type: ignore
+
+    id: int = Field(default=None, primary_key=True)
+    name: str
+    description: Optional[str] = None
+    is_discontinued: bool
diff --git a/domain/src/domain/py.typed b/domain/src/domain/py.typed
diff --git a/domain/tests/unit/__init__.py b/domain/tests/unit/__init__.py
diff --git a/domain/tests/unit/test_product.py b/domain/tests/unit/test_product.py
@@ -0,0 +1,7 @@
+import pytest
+
+
+@pytest.mark.unit
+class TestProduct:
+    def test_create_product(self) -> None:
+        assert 1 == 1
diff --git a/notebooks/notebook.ipynb b/notebooks/notebook.ipynb
@@ -0,0 +1,70 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from domain.domain_printer import DomainPrinter"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Domain printer\n"
+     ]
+    }
+   ],
+   "source": [
+    "DomainPrinter().print()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Transcriber printer\n"
+     ]
+    }
+   ],
+   "source": [
+    "from transcriber.transcriber_printer import TranscriberPrinter\n",
+    "\n",
+    "TranscriberPrinter().print()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.1"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,44 @@
+[project]
+name = "python-monorepo"
+version = "0.1.0"
+requires-python = ">=3.12"
+dependencies = [
+    "domain",
+    "fastapi[standard]==0.115.2",
+    "sqlmodel==0.0.22",
+    "test-utils",
+    "transcriber",
+]
+
+[tool.uv]
+dev-dependencies = [
+    "jupyter==1.1.1",
+    "pre-commit==4.0.1",
+    "pyright==1.1.384",
+    "pytest-asyncio==0.24.0",
+    "pytest-cov==5.0.0",
+    "pytest-mock==3.14.0",
+    "pytest==8.3.3",
+    "ruff==0.7.0",
+]
+
+[tool.uv.sources]
+api = { workspace = true }
+domain = { workspace = true }
+transcriber = { workspace = true }
+test-utils = { workspace = true }
+
+[tool.uv.workspace]
+members = ["domain", "api", "test_utils", "transcriber"]
+
+[tool.pyright]
+typeCheckingMode = "strict"
+# extraPaths = ["transcriber/src/"]
+
+[tool.ruff.lint]
+select = ["F", "E", "W", "N", "I", "ANN"]
+ignore = ["E501", "ANN101", "ANN102", "ANN401"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+markers = ["unit: Unit tests", "integration: Integration tests"]
diff --git a/scripts/script.py b/scripts/script.py
diff --git a/test_utils/pyproject.toml b/test_utils/pyproject.toml
@@ -0,0 +1,8 @@
+[project]
+name = "test-utils"
+version = "0.1.0"
+dependencies = []
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
diff --git a/test_utils/src/test_utils/__init__.py b/test_utils/src/test_utils/__init__.py
diff --git a/test_utils/src/test_utils/py.typed b/test_utils/src/test_utils/py.typed
diff --git a/transcriber/pyproject.toml b/transcriber/pyproject.toml
@@ -0,0 +1,8 @@
+[project]
+name = "transcriber"
+version = "0.1.0"
+dependencies = []
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
diff --git a/transcriber/src/transcriber/__init__.py b/transcriber/src/transcriber/__init__.py
diff --git a/transcriber/src/transcriber/transcriber_printer.py b/transcriber/src/transcriber/transcriber_printer.py
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+- [Projects](docs/projects.md)`
	`2`	`+- [Pre-commit](docs/pre-commit.md)`