pyauthenticator 0.2.1__tar.gz → 0.3.0__tar.gz

pyauthenticator-0.3.0/.gitignore

@@ -0,0 +1,13 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+
+# Coverage reports
+.coverage
+.coverage.*
+htmlcov/
+
+# Test artifacts
+*.png

{pyauthenticator-0.2.1 → pyauthenticator-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyauthenticator
-Version: 0.2.1
+Version: 0.3.0
 Summary: Similar to the Google authenticator just written in python.
 Project-URL: Homepage, https://github.com/jan-janssen/pyauthenticator
 Project-URL: Documentation, https://github.com/jan-janssen/pyauthenticator/blob/master/README.md
@@ -32,7 +32,7 @@ Requires-Dist: qrcode>=8.2
 Description-Content-Type: text/markdown
 
 # pyauthenticator
-[![Python package](https://github.com/jan-janssen/pyauthenticator/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/jan-janssen/pyauthenticator/actions/workflows/unittest.yml)
+[![Pipeline](https://github.com/jan-janssen/pyauthenticator/actions/workflows/pipeline.yml/badge.svg)](https://github.com/jan-janssen/pyauthenticator/actions/workflows/pipeline.yml)
 [![Coverage Status](https://coveralls.io/repos/github/jan-janssen/pyauthenticator/badge.svg?branch=main)](https://coveralls.io/github/jan-janssen/pyauthenticator?branch=main)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
@@ -107,7 +107,7 @@ For any support requests feel free to open an [issue on Github](https://github.c
 # For Developers 
 ## Python Interface
 The same functionality which is available on the command line is also available via the python interface:
-```
+```python
 from pyauthenticator import get_two_factor_code
 get_two_factor_code(service)
 ```
@@ -117,10 +117,10 @@ factor authentication.
 ## Configuration
 The configuration is stored in `~/.pyauthenticator` it is written in the JSON format. For a given service like `github`
 the config file contains:
-```
+```JSON
 {"google": "otpauth://totp/Google:<username>?secret=<secret>&issuer=Google"}
 ```
 With the Google username `<username>` and the corresponding secret `<secret>` being contained in the QR code.
 
 ## License 
-The `pyauthenticator` package is licensed under the [BSD-3-Clause license](https://github.com/jan-janssen/pyauthenticator/blob/main/LICENSE). 
+The `pyauthenticator` package is licensed under the [BSD-3-Clause license](https://github.com/jan-janssen/pyauthenticator/blob/main/LICENSE). 

{pyauthenticator-0.2.1 → pyauthenticator-0.3.0}/README.md

@@ -1,5 +1,5 @@
 # pyauthenticator
-[![Python package](https://github.com/jan-janssen/pyauthenticator/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/jan-janssen/pyauthenticator/actions/workflows/unittest.yml)
+[![Pipeline](https://github.com/jan-janssen/pyauthenticator/actions/workflows/pipeline.yml/badge.svg)](https://github.com/jan-janssen/pyauthenticator/actions/workflows/pipeline.yml)
 [![Coverage Status](https://coveralls.io/repos/github/jan-janssen/pyauthenticator/badge.svg?branch=main)](https://coveralls.io/github/jan-janssen/pyauthenticator?branch=main)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
@@ -74,7 +74,7 @@ For any support requests feel free to open an [issue on Github](https://github.c
 # For Developers 
 ## Python Interface
 The same functionality which is available on the command line is also available via the python interface:
-```
+```python
 from pyauthenticator import get_two_factor_code
 get_two_factor_code(service)
 ```
@@ -84,10 +84,10 @@ factor authentication.
 ## Configuration
 The configuration is stored in `~/.pyauthenticator` it is written in the JSON format. For a given service like `github`
 the config file contains:
-```
+```JSON
 {"google": "otpauth://totp/Google:<username>?secret=<secret>&issuer=Google"}
 ```
 With the Google username `<username>` and the corresponding secret `<secret>` being contained in the QR code.
 
 ## License 
-The `pyauthenticator` package is licensed under the [BSD-3-Clause license](https://github.com/jan-janssen/pyauthenticator/blob/main/LICENSE). 
+The `pyauthenticator` package is licensed under the [BSD-3-Clause license](https://github.com/jan-janssen/pyauthenticator/blob/main/LICENSE). 

{pyauthenticator-0.2.1 → pyauthenticator-0.3.0}/pyproject.toml

@@ -50,26 +50,30 @@ Source = "https://github.com/jan-janssen/pyauthenticator"
 Tracker = "https://github.com/jan-janssen/pyauthenticator/issues"
 
 [project.scripts]
-pyauthenticator = "pyauthenticator.__main__:command_line_parser"
+pyauthenticator = "pyauthenticator._cmd:command_line_parser"
 
 [tool.hatch.build]
 include = [
-    "pyauthenticator"
+    "src/pyauthenticator"
 ]
 
 [tool.hatch.build.hooks.vcs]
-version-file = "pyauthenticator/_version.py"
+version-file = "src/pyauthenticator/_version.py"
 
 [tool.hatch.build.targets.sdist]
 include = [
-    "pyauthenticator"
+    "src/pyauthenticator"
 ]
 
 [tool.hatch.build.targets.wheel]
 packages = [
-    "pyauthenticator"
+    "src/pyauthenticator"
 ]
 
 [tool.hatch.version]
 source = "vcs"
-path = "pyauthenticator/_version.py"
+path = "src/pyauthenticator/_version.py"
+
+[tool.coverage.run]
+source = ["pyauthenticator"]
+command_line = "-m unittest discover tests"

pyauthenticator-0.3.0/src/pyauthenticator/__init__.py

@@ -0,0 +1,19 @@
+"""
+Generate two factor authentication codes on the command line
+"""
+
+from . import _version
+from pyauthenticator._user import (
+    write_qrcode_to_file,
+    get_two_factor_code,
+    add_two_factor_provider,
+    list_two_factor_providers,
+)
+
+__all__ = [
+    "write_qrcode_to_file",
+    "get_two_factor_code",
+    "add_two_factor_provider",
+    "list_two_factor_providers",
+]
+__version__: str = _version.__version__

pyauthenticator-0.3.0/src/pyauthenticator/__main__.py

@@ -0,0 +1,9 @@
+"""
+Generate two factor authentication codes on the command line
+"""
+
+from pyauthenticator._cmd import command_line_parser
+
+
+if __name__ == "__main__":
+    command_line_parser()

pyauthenticator-0.2.1/pyauthenticator/__main__.py → pyauthenticator-0.3.0/src/pyauthenticator/_cmd.py

@@ -4,17 +4,18 @@ Generate two factor authentication codes on the command line
 
 import argparse
 import sys
+from typing import Optional, Sequence
 
-from pyauthenticator.share import (
+from pyauthenticator._config import load_config
+from pyauthenticator.api import (
     add_service,
     generate_qrcode,
-    get_two_factor_code,
+    get_totp_for_key_in_dict,
     list_services,
-    load_config,
 )
 
 
-def command_line_parser(cmd_args=None):
+def command_line_parser(cmd_args: Optional[Sequence[str]] = None) -> None:
     """
     Main function primarly used for the command line interface
     """
@@ -46,8 +47,14 @@ def command_line_parser(cmd_args=None):
     )
     args = parser.parse_args(args=cmd_args)
     if args.qrcode:
-        generate_qrcode(key=args.service, config_dict=config_dict)
-        print("The qrcode file <" + args.service + ".png> was generated.")
+        try:
+            generate_qrcode(key=args.service, config_dict=config_dict)
+        except KeyError:
+            _print_service_does_not_exists(
+                config_dict=config_dict, service=args.service
+            )
+        else:
+            print("The qrcode file <" + args.service + ".png> was generated.")
     elif args.add:
         add_service(
             key=args.service, qrcode_png_file_name=args.add, config_dict=config_dict
@@ -61,23 +68,25 @@ def command_line_parser(cmd_args=None):
         )
     else:
         try:
-            print(get_two_factor_code(key=args.service, config_dict=config_dict))
-        except ValueError:
-            if len(config_dict) > 0:
-                print(
-                    'The service "'
-                    + args.service
-                    + '" does not exist.\n\nThe config file ~/.pyauthenticator contains the following services:'
-                )
-                for service in list_services(config_dict=config_dict):
-                    print("  * " + service)
-                print("\nChoose one of these or add a new service using:")
-            else:
-                print(
-                    "The config file ~/.pyauthenticator does not contain any services. To add a new service use:"
-                )
-            print("  pyauthenticator --add <qr-code.png> <servicename>\n")
+            print(get_totp_for_key_in_dict(key=args.service, config_dict=config_dict))
+        except KeyError:
+            _print_service_does_not_exists(
+                config_dict=config_dict, service=args.service
+            )
 
 
-if __name__ == "__main__":
-    command_line_parser()
+def _print_service_does_not_exists(config_dict: dict, service: str) -> None:
+    if len(config_dict) > 0:
+        print(
+            'The service "'
+            + service
+            + '" does not exist.\n\nThe config file ~/.pyauthenticator contains the following services:'
+        )
+        for service_in_config in list_services(config_dict=config_dict):
+            print("  * " + service_in_config)
+        print("\nChoose one of these or add a new service using:")
+    else:
+        print(
+            "The config file ~/.pyauthenticator does not contain any services. To add a new service use:"
+        )
+    print("  pyauthenticator --add <qr-code.png> <servicename>\n")

pyauthenticator-0.3.0/src/pyauthenticator/_config.py

@@ -0,0 +1,42 @@
+"""
+Configuration file handling for pyauthenticator
+"""
+
+import json
+from os.path import exists, abspath, expanduser
+from typing import Any, Dict
+
+# default configuration file
+default_config_file: str = "~/.pyauthenticator"
+
+
+def load_config(config_file_to_load: str = default_config_file) -> Dict[str, Any]:
+    """
+    Load configuration file
+
+    Args:
+        config_file_to_load (str): path to config file
+
+    Returns:
+        dict: Dictionary with service names as keys and the otpauth url as values
+    """
+    abs_config_path = abspath(expanduser(config_file_to_load))
+    if exists(abs_config_path):
+        with open(abs_config_path, "r") as f:
+            return json.load(f)
+    else:
+        return {}
+
+
+def write_config(
+    config_dict: Dict[str, Any], config_file_to_write: str = default_config_file
+) -> None:
+    """
+    Write configuration file
+
+    Args:
+        config_dict (dict): configuration dictionary
+        config_file_to_write (str): path to config file
+    """
+    with open(abspath(expanduser(config_file_to_write)), "w") as f:
+        json.dump(config_dict, f)

pyauthenticator-0.3.0/src/pyauthenticator/_core.py

@@ -0,0 +1,64 @@
+"""
+Core functionality to generate two factor authentication codes
+"""
+
+from typing import Any
+
+import pyotp
+import qrcode
+from PIL import Image
+from pyzbar.pyzbar import decode
+
+
+def decode_qrcode(qrcode_png_file_name: str) -> str:
+    """
+    Decode qrcode from png file
+
+    Args:
+        qrcode_png_file_name (str): path to the png file which contains the qr code
+
+    Returns:
+        str: decoded otpauth string
+    """
+    return decode(Image.open(qrcode_png_file_name))[0].data.decode("utf-8")
+
+
+def encode_qrcode(otpauth_str: str, file_name: str) -> None:
+    """
+    Encode otpauth string into qrcode image saved as png file
+
+    Args:
+        otpauth_str (str): otpauth string
+        file_name (str): path to the png file which will contain the qr code
+    """
+    qrcode.make(otpauth_str).save(file_name, "PNG")
+
+
+def get_totp(otpauth_str: str) -> str:
+    """
+    Get TOTP code for a specific service based on its otpauth dictionary
+
+    Args:
+        otpauth_str (str): otpauth string for the service
+
+    Returns:
+        str: TOTP code for the service
+    """
+    otpauth_dict = {
+        kv[0]: kv[1]
+        for kv in [
+            otpvar.split("=") for otpvar in otpauth_str.replace("?", "&").split("&")[1:]
+        ]
+    }
+
+    kwargs: dict[str, Any] = {}
+    if "digits" in otpauth_dict.keys():
+        kwargs["digits"] = int(otpauth_dict["digits"])
+    if "period" in otpauth_dict.keys():
+        kwargs["interval"] = int(otpauth_dict["period"])
+    if "issuer" in otpauth_dict.keys():
+        kwargs["issuer"] = otpauth_dict["issuer"]
+    return pyotp.TOTP(
+        **kwargs,
+        s=otpauth_dict["secret"],
+    ).now()

pyauthenticator-0.3.0/src/pyauthenticator/_user.py

@@ -0,0 +1,65 @@
+"""
+Generate two factor authentication codes on the command line
+"""
+
+from typing import Optional
+from pyauthenticator._config import default_config_file, load_config
+from pyauthenticator.api import (
+    add_service,
+    generate_qrcode,
+    get_totp_for_key_in_dict,
+    list_services,
+)
+
+
+def write_qrcode_to_file(service: str, file_name: Optional[str] = None) -> None:
+    """
+    Write qrcode to file to scan it with a mobile application
+
+    Args:
+        service (str): lower case name of the service
+        file_name (str/ None): default file name <service.png>
+    """
+    generate_qrcode(key=service, config_dict=load_config(), file_name=file_name)
+
+
+def get_two_factor_code(service: str) -> str:
+    """
+    Generate two factor authentication code
+
+    Args:
+        service (str): lower case name of the service
+
+    Returns:
+        str: two factor authentication code
+    """
+    return get_totp_for_key_in_dict(
+        key=service,
+        config_dict=load_config(),
+    )
+
+
+def add_two_factor_provider(service: str, qrcode_png_file_name: str) -> None:
+    """
+    Add new two factor authentication provider to configuration file
+
+    Args:
+        service (str): lower case name of the service
+        qrcode_png_file_name (str): path to the png file which contains the qr code
+    """
+    add_service(
+        key=service,
+        qrcode_png_file_name=qrcode_png_file_name,
+        config_dict=load_config(),
+        config_file_to_write=default_config_file,
+    )
+
+
+def list_two_factor_providers() -> list[str]:
+    """
+    List all two factor authentication providers in the configuration file
+
+    Returns:
+        list[str]: list of two factor authentication providers
+    """
+    return list_services(config_dict=load_config())

{pyauthenticator-0.2.1 → pyauthenticator-0.3.0/src}/pyauthenticator/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.2.1'
-__version_tuple__ = version_tuple = (0, 2, 1)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)
+
+__commit_id__ = commit_id = None

pyauthenticator-0.3.0/src/pyauthenticator/api.py

@@ -0,0 +1,70 @@
+"""
+Shared functionality to generate two factor authentication codes
+"""
+
+from typing import Any, Dict, List, Optional
+
+from pyauthenticator._core import decode_qrcode, encode_qrcode, get_totp
+from pyauthenticator._config import default_config_file, write_config
+
+
+def get_totp_for_key_in_dict(key: str, config_dict: Dict[str, Any]) -> str:
+    """
+    Generate the two factor authentication code
+
+    Args:
+        key (str): lower case name of the service
+        config_dict (dict): configuration dictionary
+
+    Returns:
+        str: two factor authentication code as string
+    """
+    return get_totp(otpauth_str=config_dict[key])
+
+
+def add_service(
+    key: str,
+    qrcode_png_file_name: str,
+    config_dict: Dict[str, Any],
+    config_file_to_write: str = default_config_file,
+) -> None:
+    """
+    Add new service to configuration file
+
+    Args:
+        key (str): lower case name of the service
+        qrcode_png_file_name (str): path to the png file which contains the qr code
+        config_dict (dict): configuration dictionary
+        config_file_to_write (str): path to config file
+    """
+    config_dict[key] = decode_qrcode(qrcode_png_file_name=qrcode_png_file_name)
+    write_config(config_dict=config_dict, config_file_to_write=config_file_to_write)
+
+
+def generate_qrcode(
+    key: str, config_dict: Dict[str, Any], file_name: Optional[str] = None
+) -> None:
+    """
+    Write qrcode to file to scan it with a mobile application
+
+    Args:
+        key (str): lower case name of the service
+        config_dict (dict): configuration dictionary
+        file_name (str/ None): default file name <service.png>
+    """
+    if file_name is None:
+        file_name = key + ".png"
+    encode_qrcode(otpauth_str=config_dict[key], file_name=file_name)
+
+
+def list_services(config_dict: Dict[str, Any]) -> List[str]:
+    """
+    List available services
+
+    Args:
+        config_dict (dict): configuration dictionary
+
+    Returns:
+        list: list of available services
+    """
+    return list(config_dict.keys())

pyauthenticator-0.2.1/pyauthenticator/__init__.py

@@ -1,37 +0,0 @@
-"""
-Generate two factor authentication codes on the command line
-"""
-
-from . import _version
-from pyauthenticator.share import generate_qrcode
-from pyauthenticator.share import get_two_factor_code as get_two_factor_code_internal
-from pyauthenticator.share import load_config
-
-__version__ = _version.__version__
-
-
-def write_qrcode_to_file(service, file_name=None):
-    """
-    Write qrcode to file to scan it with a mobile application
-
-    Args:
-        service (str): lower case name of the service
-        file_name (str/ None): default file name <service.png>
-    """
-    generate_qrcode(key=service, config_dict=load_config(), file_name=file_name)
-
-
-def get_two_factor_code(service):
-    """
-    Generate two factor authentication code
-
-    Args:
-        service (str): lower case name of the service
-
-    Returns:
-        str: two factor authentication code
-    """
-    return get_two_factor_code_internal(
-        key=service,
-        config_dict=load_config(),
-    )

pyauthenticator-0.2.1/pyauthenticator/share.py

@@ -1,167 +0,0 @@
-"""
-Shared functionality to generate two factor authentication codes
-"""
-
-import json
-import os
-from inspect import signature
-
-import pyotp
-import qrcode
-from PIL import Image
-from pyzbar.pyzbar import decode
-
-# default configuration file
-config_file = "~/.pyauthenticator"
-
-
-def expand_path(path):
-    """
-    Expand path by expanding the user variable and converting the path to an absolute path
-
-    Args:
-        path (str): path before expansion
-
-    Returns:
-        str: expanded path
-    """
-    return os.path.abspath(os.path.expanduser(path))
-
-
-def load_config(config_file_to_load=config_file):
-    """
-    Load configuration file
-
-    Args:
-        config_file_to_load (str): path to config file
-
-    Returns:
-        dict: Dictionary with service names as keys and the otpauth url as values
-    """
-    abs_config_path = expand_path(path=config_file_to_load)
-    if os.path.exists(abs_config_path):
-        with open(abs_config_path, "r") as f:
-            return json.load(f)
-    else:
-        return {}
-
-
-def write_config(config_dict, config_file_to_write=config_file):
-    """
-    Write configuration file
-
-    Args:
-        config_dict (dict): configuration dictionary
-        config_file_to_write (str): path to config file
-    """
-    with open(expand_path(path=config_file_to_write), "w") as f:
-        json.dump(config_dict, f)
-
-
-def get_otpauth_dict(otpauth_str):
-    """
-    Parse otpauth url
-
-    Args:
-        otpauth_str (str): otpauth url as string
-
-    Returns:
-        dict: Dictionary with the parameters of the otpauth url as key-value pairs
-    """
-    return {
-        kv[0]: kv[1]
-        for kv in [
-            otpvar.split("=") for otpvar in otpauth_str.replace("?", "&").split("&")[1:]
-        ]
-    }
-
-
-def check_if_key_in_config(key, config_dict):
-    """
-    Check if a given key is included in a dictionary, raise an ValueError if it is not.
-
-    Args:
-        key (str): key as string
-        config_dict (dict): configuration dictionary
-    """
-    if key not in config_dict.keys():
-        raise ValueError()
-
-
-def get_two_factor_code(key, config_dict):
-    """
-    Generate the two factor authentication code
-
-    Args:
-        key (str): lower case name of the service
-        config_dict (dict): configuration dictionary
-
-    Returns:
-        str: two factor authentication code as string
-    """
-    check_if_key_in_config(key=key, config_dict=config_dict)
-    decode_dict_internal = get_otpauth_dict(otpauth_str=config_dict[key])
-    funct_sig = signature(pyotp.TOTP)
-    if "digits" in decode_dict_internal.keys():
-        digits = int(decode_dict_internal["digits"])
-    else:
-        digits = funct_sig.parameters["digits"].default
-    if "period" in decode_dict_internal.keys():
-        interval = int(decode_dict_internal["period"])
-    else:
-        interval = funct_sig.parameters["interval"].default
-    if "issuer" in decode_dict_internal.keys():
-        issuer = decode_dict_internal["issuer"]
-    else:
-        issuer = funct_sig.parameters["issuer"].default
-    return pyotp.TOTP(
-        s=decode_dict_internal["secret"],
-        digits=digits,
-        issuer=issuer,
-        interval=interval,
-    ).now()
-
-
-def add_service(
-    key, qrcode_png_file_name, config_dict, config_file_to_write=config_file
-):
-    """
-    Add new service to configuration file
-
-    Args:
-        key (str): lower case name of the service
-        qrcode_png_file_name (str): path to the png file which contains the qr code
-        config_dict (dict): configuration dictionary
-        config_file_to_write (str): path to config file
-    """
-    otpauth_str = decode(Image.open(qrcode_png_file_name))[0].data.decode("utf-8")
-    config_dict[key] = otpauth_str
-    write_config(config_dict=config_dict, config_file_to_write=config_file_to_write)
-
-
-def generate_qrcode(key, config_dict, file_name=None):
-    """
-    Write qrcode to file to scan it with a mobile application
-
-    Args:
-        key (str): lower case name of the service
-        config_dict (dict): configuration dictionary
-        file_name (str/ None): default file name <service.png>
-    """
-    if file_name is None:
-        file_name = key + ".png"
-    check_if_key_in_config(key=key, config_dict=config_dict)
-    qrcode.make(config_dict[key]).save(file_name, "PNG")
-
-
-def list_services(config_dict):
-    """
-    List available services
-
-    Args:
-        config_dict (dict): configuration dictionary
-
-    Returns:
-        list: list of available services
-    """
-    return list(config_dict.keys())