Add hatch config for build

.github/workflows/python-test.yml

@@ -0,0 +1,43 @@
+name: Python Unit Tests
+on: [push, pull_request]
+
+concurrency:
+  group: test-${{ github.head_ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHONUNBUFFERED: "1"
+  FORCE_COLOR: "1"
+
+jobs:
+  run:
+    name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Hatch
+      run: pip install --upgrade hatch
+    - name: Run tests and track code coverage
+      run: hatch run cov
+  run-container-matrix:
+    name: Container matrix on Linux
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+    - name: Install Hatch
+      run: pip install --upgrade hatch hatch-containers
+    - name: Run tests in container matrix
+      run: hatch run all:test

.gitignore

@@ -1,7 +1,9 @@
 # Repo specifc ignore
+/src/couch_potato/_version.py
+dist/
 .python-version
-couch-potato/__pycache__/
-tests/local_test.py
+**/__pycache__/
+local_test.py
 
 # Generic ignore
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider

hatch.toml

@@ -0,0 +1,23 @@
+[envs.default]
+dependencies = [
+  "coverage[toml]>=6.5",
+  "pytest",
+]
+
+[envs.default.scripts]
+test = "pytest {args:tests}"
+test-cov = "coverage run -m pytest {args:tests}"
+cov-report = [
+  "- coverage combine",
+  "coverage report --show-missing",
+]
+cov = [
+  "test-cov",
+  "cov-report",
+]
+
+[envs.all]
+type = "container"
+
+[[envs.all.matrix]]
+python = ["3.7", "3.8", "3.9", "3.10", "3.11"]

pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs", "hatch-requirements-txt"]
+build-backend = "hatchling.build"
+
+[project]
+name="couch_potato"
+dynamic = ["version", "dependencies"]
+readme = "README.md"
+requires-python = ">=3.7"
+license-files = { paths = ["LICENSE.md"] }
+authors = [
+  { name = "Tim Bradgate", email = "timbradgate@hotmail.co.uk" },
+]
+keywords=["couchbase", "odm", "orm"]
+classifiers=[
+  "Development Status :: 3 - Alpha",
+  "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Topic :: Database",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+[project.urls]
+Documentation = "https://github.com/Tim020/couch-potato"
+"Source code" = "https://github.com/Tim020/couch-potato"
+Issues = "https://github.com/Tim020/couch-potato/issues"
+
+[tool.hatch.metadata.hooks.requirements_txt]
+files = ["requirements.txt"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/couch_potato/_version.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+  "/.github",
+  "dist"
+]

couch-potato/_model.py → src/couch_potato/_model.py

@@ -1,10 +1,10 @@
 from typing import TYPE_CHECKING, Dict
 
-from _types import BucketBind, ScopeBind, Field
-from model import BaseModel, KeyGenerator
+from src.couch_potato._types import BucketBind, ScopeBind, Field
+from src.couch_potato.model import BaseModel, KeyGenerator
 
 if TYPE_CHECKING:
-    from couch_potato import CouchPotato
+    from src.couch_potato.couch_potato import CouchPotato
 
 
 def make_meta_model(cp: "CouchPotato"):

couch-potato/couch_potato.py → src/couch_potato/couch_potato.py

@@ -4,9 +4,9 @@
 from couchbase.cluster import Cluster
 from couchbase.collection import Collection
 
-from _types import BucketBind
-from _model import make_meta_model
-from model import BaseModel
+from src.couch_potato._types import BucketBind
+from src.couch_potato._model import make_meta_model
+from src.couch_potato.model import BaseModel
 
 
 class CouchPotato:

couch-potato/fields.py → src/couch_potato/fields.py

@@ -1,4 +1,4 @@
-from _types import Field
+from src.couch_potato._types import Field
 
 
 class Integer(Field):

couch-potato/model.py → src/couch_potato/model.py

@@ -5,7 +5,7 @@
 from couchbase.options import InsertOptions, ReplaceOptions
 from couchbase.scope import Scope
 
-from errors import ModelAttributeError, FieldNotFound, ReadOnlyError
+from src.couch_potato.errors import ModelAttributeError, FieldNotFound, ReadOnlyError
 
 T = TypeVar('T', bound='BaseModel')
 

tests/test_dummy.py

@@ -0,0 +1,3 @@
+def test_dummy():
+    print("Hello world")
+    assert True