Define initial class for EAR claimset along with its unit test, setup tox for testing (#3)

* Initialize project python-ear
* Define initial class for EAR claimset along with its unit test, setup tox for testing
* Use dataclasses for definition of EARClaims class
* Remove cache files

---------

Signed-off-by: HarshvMahawar <[email protected]>

Author: HarshvMahawar

.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

.pylintrc

@@ -0,0 +1,8 @@
+[MESSAGES CONTROL]
+disable = C0114, C0115, C0116  ; Disable missing module/class/function docstring warnings
+
+[FORMAT]
+max-line-length = 88  ; Match Black's default line length
+
+[MASTER]
+ignore = venv  ; Ignore virtual environment folder

README.md

@@ -1,3 +1,26 @@
 # python-ear
 
 A python implementation of [draft-fv-rats-ear](https://datatracker.ietf.org/doc/draft-fv-rats-ear/).
+
+# Proposal
+
+Following are the tools that will be used in the development of this library
+
+## CWT and JWT creation
+
+1. [python-cwt](https://python-cwt.readthedocs.io/en/stable/)
+2. [python-jwt](https://pypi.org/project/python-jose/)
+
+## Code formatting and styling
+
+1. [black](https://pypi.org/project/black/)
+2. [isort](https://pypi.org/project/isort/)
+
+## Linting and static analysis
+
+1. [flake8](https://pypi.org/project/flake8/)
+2. [mypy](https://pypi.org/project/mypy/)
+
+## Testing
+
+1. [pytest](https://pypi.org/project/pytest/)

requirements.txt

@@ -0,0 +1,10 @@
+python-jose==3.4.0
+cwt==2.8.0
+black==24.8.0
+isort==5.12.0
+flake8==6.0.0
+mypy==1.5.1
+pytest==7.4.2
+tox==4.24.1
+pyright==1.1.325
+pylint==2.17.5

src/__init__.py

@@ -0,0 +1,35 @@
+import json
+from dataclasses import dataclass, field
+from typing import Any, Dict
+
+
+@dataclass
+class EARClaims:
+    profile: str
+    issued_at: int
+    verifier_id: Dict[str, str] = field(default_factory=dict)
+    submods: Dict[str, Any] = field(default_factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        return {
+            "eat_profile": self.profile,
+            "iat": self.issued_at,
+            "ear.verifier-id": self.verifier_id,
+            "submods": self.submods,
+        }
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]):
+        return cls(
+            profile=data.get("eat_profile", ""),
+            issued_at=data.get("iat", 0),
+            verifier_id=data.get("ear.verifier-id", {}),
+            submods=data.get("submods", {}),
+        )
+
+    def to_json(self) -> str:
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str):
+        return cls.from_dict(json.loads(json_str))

src/claims.py

@@ -0,0 +1,13 @@
+from src.claims import EARClaims
+
+
+def test_ear_claims():
+    claims = EARClaims(
+        "test_profile",
+        1234567890,
+        {"build": "v1"},
+        {"submods1": {"status": "affirming"}},
+    )
+    json_str = claims.to_json()
+    parsed_claims = EARClaims.from_json(json_str)
+    assert parsed_claims.to_dict() == claims.to_dict()

tests/__init__.py

@@ -0,0 +1,23 @@
+[tox]
+envlist = lint, test
+
+[testenv:lint]
+deps =
+    isort==5.12.0
+    black==24.8.0
+    flake8==6.0.0
+    mypy==1.5.1
+    pylint==2.17.5
+    pyright==1.1.325
+commands =
+    isort . --check --diff
+    black . --check --diff
+    flake8 .
+    mypy .
+    pylint src tests
+    pyright
+
+[testenv:test]
+deps =
+    pytest==7.4.2
+commands = pytest