chore: use uv to manage project, ruff to lint code

Author: lepture

.github/workflows/tests.yml

@@ -22,10 +22,10 @@ jobs:
           python-version: "3.8"
 
       - name: Install dependencies
-        run: pip install -r requirements.txt
+        run: pip install -r requirements-dev.lock
 
-      - name: flake8 lint
-        run: flake8 src/otpauth/
+      - name: ruff lint
+        run: ruff check
 
       - name: mypy lint
         run: mypy

.gitignore

@@ -161,3 +161,5 @@ cython_debug/
 #  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/
+
+uv.lock

docs/conf.py

@@ -1,10 +1,10 @@
 import otpauth
 
-project = 'OTP Auth'
-copyright = '2013, Hsiaoming Yang'
-author = 'Hsiaoming Yang'
+project = "OTP Auth"
+copyright = "2013, Hsiaoming Yang"
+author = "Hsiaoming Yang"
 
-master_doc = 'index'
+master_doc = "index"
 
 # The full version, including alpha/beta/rc tags
 version = otpauth.__version__
@@ -32,12 +32,12 @@
 sitemap_url_scheme = "{link}"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 html_static_path = ["_static"]
 
@@ -47,41 +47,33 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'shibuya'
+html_theme = "shibuya"
 html_theme_options = {
     "accent_color": "blue",
     "light_logo": "_static/light-logo.svg",
     "dark_logo": "_static/dark-logo.svg",
-    'twitter_site': 'authlib',
-    'twitter_creator': 'lepture',
-    'twitter_url': 'https://twitter.com/authlib',
-    'github_url': 'https://github.com/authlib/otpauth',
-    'discord_url': 'https://discord.gg/HvBVAeNAaV',
+    "twitter_site": "authlib",
+    "twitter_creator": "lepture",
+    "twitter_url": "https://twitter.com/authlib",
+    "github_url": "https://github.com/authlib/otpauth",
+    "discord_url": "https://discord.gg/HvBVAeNAaV",
     "carbon_ads_code": "CE7DKK3W",
     "carbon_ads_placement": "otpauthliborg",
     "nav_links": [
         {
             "title": "Projects",
             "children": [
-                {
-                    "title": "Authlib",
-                    "url": "https://authlib.org/",
-                    "summary": "OAuth, JOSE, OpenID, etc."
-                },
-                {
-                    "title": "JOSE RFC",
-                    "url": "https://jose.authlib.org/",
-                    "summary": "JWS, JWE, JWK, and JWT."
-                },
+                {"title": "Authlib", "url": "https://authlib.org/", "summary": "OAuth, JOSE, OpenID, etc."},
+                {"title": "JOSE RFC", "url": "https://jose.authlib.org/", "summary": "JWS, JWE, JWK, and JWT."},
                 {
                     "title": "OTP Auth",
                     "url": "https://otp.authlib.org/",
                     "summary": "One time password, HOTP/TOTP.",
                 },
-            ]
+            ],
         },
         {"title": "Sponsor me", "url": "https://github.com/sponsors/authlib"},
-    ]
+    ],
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

pyproject.toml

@@ -30,22 +30,25 @@ classifiers = [
 ]
 
 [project.urls]
+Source = "https://github.com/authlib/otpauth"
 Documentation = "https://otp.authlib.org/"
 Donate = "https://github.com/sponsors/authlib"
 Blog = "https://blog.authlib.org/"
 
 [build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
-[tool.setuptools.dynamic]
-version = {attr = "otpauth.__version__"}
-
-[tool.setuptools.packages.find]
-where = ["src"]
+[dependency-groups]
+dev = [
+    "mypy>=1.4.1",
+    "pytest>=7.4.4",
+    "pytest-cov>=4.1.0",
+    "ruff>=0.9.9",
+]
 
-[tool.setuptools.package-data]
-"otpauth" = ["py.typed"]
+[tool.hatch.version]
+path = "src/otpauth/__init__.py"
 
 [tool.pytest.ini_options]
 pythonpath = ["src"]
@@ -72,3 +75,25 @@ python_version = "3.8"
 files = ["src/otpauth"]
 show_error_codes = true
 pretty = true
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "B", # flake8-bugbear
+    "E", # pycodestyle
+    "F", # pyflakes
+    "I", # isort
+    "UP", # pyupgrade
+]
+ignore = [
+    "E501", # line-too-long
+    "E722", # bare-except
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[tool.ruff.format]
+docstring-code-format = true

requirements-dev.lock

@@ -0,0 +1,29 @@
+# This file was autogenerated by uv via the following command:
+#    uv export --no-hashes -o requirements-dev.lock
+-e .
+colorama==0.4.6 ; sys_platform == 'win32'
+coverage==7.2.7 ; python_full_version < '3.8'
+coverage==7.6.1 ; python_full_version == '3.8.*'
+coverage==7.6.12 ; python_full_version >= '3.9'
+exceptiongroup==1.2.2 ; python_full_version < '3.11'
+importlib-metadata==6.7.0 ; python_full_version < '3.8'
+iniconfig==2.0.0
+mypy==1.4.1 ; python_full_version < '3.8'
+mypy==1.14.1 ; python_full_version == '3.8.*'
+mypy==1.15.0 ; python_full_version >= '3.9'
+mypy-extensions==1.0.0
+packaging==24.0 ; python_full_version < '3.8'
+packaging==24.2 ; python_full_version >= '3.8'
+pluggy==1.2.0 ; python_full_version < '3.8'
+pluggy==1.5.0 ; python_full_version >= '3.8'
+pytest==7.4.4 ; python_full_version < '3.8'
+pytest==8.3.4 ; python_full_version >= '3.8'
+pytest-cov==4.1.0 ; python_full_version < '3.8'
+pytest-cov==5.0.0 ; python_full_version == '3.8.*'
+pytest-cov==6.0.0 ; python_full_version >= '3.9'
+ruff==0.9.9
+tomli==2.0.1 ; python_full_version < '3.8'
+tomli==2.2.1 ; python_full_version >= '3.8' and python_full_version <= '3.11'
+typed-ast==1.5.5 ; python_full_version < '3.8'
+typing-extensions==4.7.1
+zipp==3.15.0 ; python_full_version < '3.8'

requirements.txt

@@ -1,7 +1,8 @@
+from ._rfc4226 import HOTP
+from ._rfc4226 import generate_hotp
+from ._rfc6238 import TOTP
+from ._rfc6238 import generate_totp
 from .core import SupportedAlgorithms
-from ._rfc4226 import HOTP, generate_hotp
-from ._rfc6238 import TOTP, generate_totp
-
 
 __author__ = "Hsiaoming Yang <[email protected]>"
 __homepage__ = "https://otp.authlib.org/"

src/otpauth/__init__.py

@@ -1,8 +1,10 @@
-import typing as t
-import struct
-import hmac
 import hashlib
-from .core import OTP, SupportedAlgorithms
+import hmac
+import struct
+import typing as t
+
+from .core import OTP
+from .core import SupportedAlgorithms
 
 
 class HOTP(OTP):
@@ -27,7 +29,7 @@ def generate(self, counter: int) -> int:
         """
         return generate_hotp(self.secret, counter, self.digit, self.algorithm)
 
-    def verify(self, code: int, counter: int) -> bool:  # type: ignore[override]
+    def verify(self, code: int, counter: int) -> bool:
         """Valid a HOTP code at the given counter.
 
         :param code: A number to be verified.
@@ -37,7 +39,7 @@ def verify(self, code: int, counter: int) -> bool:  # type: ignore[override]
             return False
         return hmac.compare_digest(self.string_code(self.generate(counter)), self.string_code(code))
 
-    def to_uri(self, label: str, issuer: str, counter: int) -> str:  # type: ignore[override]
+    def to_uri(self, label: str, issuer: str, counter: int) -> str:
         """Generate the otpauth protocal string for HOTP.
 
         :param label: Label of the identifier.
@@ -60,7 +62,7 @@ def generate_hotp(secret: bytes, counter: int, digit: int = 6, algorithm: Suppor
     msg = struct.pack(">Q", counter)
     digest = hmac.new(secret, msg, hash_alg).digest()
     offset = digest[19] & 0xF
-    bin_code: int = struct.unpack(">I", digest[offset: offset + 4])[0]
+    bin_code: int = struct.unpack(">I", digest[offset : offset + 4])[0]
     total: int = bin_code & 0x7FFFFFFF
-    power: int = 10 ** digit
+    power: int = 10**digit
     return total % power

src/otpauth/_rfc4226.py

@@ -1,8 +1,10 @@
-import typing as t
-import time
 import hmac
-from .core import OTP, SupportedAlgorithms
+import time
+import typing as t
+
 from ._rfc4226 import generate_hotp
+from .core import OTP
+from .core import SupportedAlgorithms
 
 
 class TOTP(OTP):
@@ -32,7 +34,7 @@ def generate(self, timestamp: t.Optional[int] = None) -> int:
         """
         return generate_totp(self.secret, self.period, timestamp, self.digit, self.algorithm)
 
-    def verify(self, code: int, timestamp: t.Optional[int] = None) -> bool:  # type: ignore[override]
+    def verify(self, code: int, timestamp: t.Optional[int] = None) -> bool:
         """Valid a TOTP code for the given timestamp.
 
         :param code: A number to be verified.
@@ -42,7 +44,7 @@ def verify(self, code: int, timestamp: t.Optional[int] = None) -> bool:  # type:
             return False
         return hmac.compare_digest(self.string_code(self.generate(timestamp)), self.string_code(code))
 
-    def to_uri(self, label: str, issuer: str) -> str:  # type: ignore[override]
+    def to_uri(self, label: str, issuer: str) -> str:
         """Generate the otpauth protocal string for TOTP.
 
         :param label: Label of the identifier.
@@ -53,11 +55,12 @@ def to_uri(self, label: str, issuer: str) -> str:  # type: ignore[override]
 
 
 def generate_totp(
-        secret: bytes,
-        period: int = 30,
-        timestamp: t.Optional[int] = None,
-        digit: int = 6,
-        algorithm: SupportedAlgorithms = "SHA1") -> int:
+    secret: bytes,
+    period: int = 30,
+    timestamp: t.Optional[int] = None,
+    digit: int = 6,
+    algorithm: SupportedAlgorithms = "SHA1",
+) -> int:
     """Generate a TOTP code.
 
     A TOTP code is an extension of TOTP algorithm.

src/otpauth/_rfc6238.py

@@ -1,7 +1,8 @@
 import base64
 import typing as t
+from abc import ABCMeta
+from abc import abstractmethod
 from urllib.parse import quote
-from abc import ABCMeta, abstractmethod
 
 SupportedAlgorithms = t.Literal["SHA1", "SHA256", "SHA512"]
 Self = t.TypeVar("Self", bound="OTP")
@@ -33,10 +34,8 @@ def b32_secret(self) -> str:
 
     @classmethod
     def from_b32encode(
-            cls: t.Type[Self],
-            secret: t.Union[bytes, str],
-            digit: int = 6,
-            algorithm: SupportedAlgorithms = "SHA1") -> Self:
+        cls: t.Type[Self], secret: t.Union[bytes, str], digit: int = 6, algorithm: SupportedAlgorithms = "SHA1"
+    ) -> Self:
         """Create the instance with a base32 encoded secret.
 
         :param secret: A base32 encoded secret string or bytes.
@@ -80,16 +79,13 @@ def string_code(self, code: int) -> str:
 
         :param code: The number that this OTP generated.
         """
-        return f'{code:0{self.digit}}'
+        return f"{code:0{self.digit}}"
 
     @abstractmethod
-    def generate(self, *args: t.Any, **kwargs: t.Any) -> int:
-        ...
+    def generate(self, *args: t.Any, **kwargs: t.Any) -> int: ...
 
     @abstractmethod
-    def verify(self, code: int, *args: t.Any, **kwargs: t.Any) -> bool:
-        ...
+    def verify(self, code: int, *args: t.Any, **kwargs: t.Any) -> bool: ...
 
     @abstractmethod
-    def to_uri(self, label: str, issuer: str, *args: t.Any, **kwargs: t.Any) -> str:
-        ...
+    def to_uri(self, label: str, issuer: str, *args: t.Any, **kwargs: t.Any) -> str: ...