Package caskdb for PyPI (#19)

.github/workflows/build.yml

@@ -38,4 +38,5 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: tests
         run: |
+          pip install .
           make test

Makefile

@@ -9,7 +9,7 @@ test:
 lint:
 	black --check --diff $(FILES_TO_LINT)
 	flake8 $(FILES_TO_LINT)
-	mypy --strict $(FILES_TO_LINT)
+	mypy .
 	pytype $(FILES_TO_LINT)
 
 coverage:

mypy.ini

@@ -0,0 +1,3 @@
+[mypy]
+exclude = venv|setup.py
+strict = True

requirements_dev.txt

@@ -1,7 +1 @@
-black>=22.1.0
-coverage>=6.3.2
-flake8>=4.0.1
-ipdb>=0.13.9
-mypy>=0.950
-pytype>=2022.4.26
-pytest>=7.1.2
+-e .[dev]

setup.cfg

@@ -0,0 +1,47 @@
+[metadata]
+name = caskdb
+version = 0.1.0
+description = Disk based Log Structured Hash Table Store
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/avinassh/py-caskdb
+author = Avinash Sajjanshetty
+author_email = [email protected]
+license = MIT
+license_file = LICENSE
+classifiers =
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
+    Programming Language :: Python :: 3.12
+    Programming Language :: Python :: Implementation :: CPython
+    Typing :: Typed
+
+[options]
+packages = find:
+python_requires = >=3.8
+package_dir = =src
+
+[options.packages.find]
+where = ./src
+
+[options.extras_require]
+dev =
+    black>=22.1.0
+    build>=1.2.1
+    coverage>=6.3.2
+    flake8>=4.0.1
+    ipdb>=0.13.9
+    mypy>=1.10.1
+    pytest>=7.1.2
+    pytype>=2024.4.11
+    twine>=5.1.1
+
+[options.package_data]
+caskdb =
+    py.typed

setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

src/caskdb/__init__.py

@@ -0,0 +1,4 @@
+from caskdb.disk_store import DiskStorage
+from caskdb.memory_store import MemoryStorage
+
+__all__ = ["DiskStorage", "MemoryStorage"]

disk_store.py → src/caskdb/disk_store.py

@@ -19,11 +19,12 @@
     # it also supports dictionary style API too:
     disk["hamlet"] = "shakespeare"
 """
+
 import os.path
 import time
 import typing
 
-from format import KeyEntry, encode_kv, decode_kv, HEADER_SIZE, decode_header
+from caskdb.format import KeyEntry, encode_kv, decode_kv, HEADER_SIZE, decode_header
 
 # We use `file.seek` method to move our cursor to certain byte offset for read
 # or write operations. The method takes two parameters file.seek(offset, whence).

example.py → src/caskdb/example.py

@@ -1,5 +1,5 @@
-from memory_store import MemoryStorage
-from disk_store import DiskStorage
+from caskdb.memory_store import MemoryStorage
+from caskdb.disk_store import DiskStorage
 
 
 def memory_db() -> None:

src/caskdb/memory_store.py

@@ -0,0 +1,12 @@
+class MemoryStorage:
+    def __init__(self) -> None:
+        self.data: dict[str, str] = {}
+
+    def set(self, key: str, value: str) -> None:
+        self.data[key] = value
+
+    def get(self, key: str) -> str:
+        return self.data.get(key, "")
+
+    def close(self) -> None:
+        return

src/caskdb/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561. This package uses inline types.

tests/test_disk_store.py

@@ -3,7 +3,7 @@
 import typing
 import unittest
 
-from disk_store import DiskStorage
+from caskdb import DiskStorage
 
 
 class TempStorageFile:

tests/test_format.py

@@ -5,8 +5,14 @@
 import unittest
 import uuid
 
-from format import encode_header, decode_header, encode_kv, decode_kv, HEADER_SIZE
-from format import KeyEntry
+from caskdb.format import (
+    encode_header,
+    decode_header,
+    encode_kv,
+    decode_kv,
+    HEADER_SIZE,
+)
+from caskdb.format import KeyEntry
 
 
 def get_random_header() -> tuple[int, int, int]:

tests/test_memory_store.py

@@ -1,6 +1,6 @@
 import unittest
 
-from memory_store import MemoryStorage
+from caskdb import MemoryStorage
 
 
 class TestInMemoryCaskDB(unittest.TestCase):
@@ -15,4 +15,4 @@ def test_invalid_key(self) -> None:
 
     def test_close(self) -> None:
         store = MemoryStorage()
-        self.assertTrue(store.close())
+        store.close()