api-key-factory 1.0.0__py3-none-any.whl

api_key_factory/api_key_factory.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+
+import click
+
+from api_key_factory.factory.key import Key
+
+
+@click.group()
+@click.version_option("1.0.0", prog_name="api_key_factory")
+def cli() -> None:
+    """A simple CLI tool to generate API keys and their corresponding
+    SHA-256 hashes.
+    """
+    pass
+
+
+@cli.command()
+@click.option(
+    "-n",
+    "--num",
+    "num",
+    type=click.IntRange(min=1),
+    default=1,
+    help="Number of API keys to generate",
+)
+def generate(
+    num: int,
+) -> None:
+    """Command to generate API keys and their corresponding SHA-256 hashes.
+
+    Args:
+        num (int): Number of API keys to generate. Default 1.
+
+    Raises:
+        click.ClickException: Error when writing output file
+    """
+    for _ in range(num):
+        key = Key()
+        click.echo(f"{key.get_value()}   {key.get_hash()}")
+
+
+if __name__ == "__main__":
+    cli()  # pragma: no cover

api_key_factory/factory/key.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+import hashlib
+import uuid
+
+from pydantic import BaseModel
+
+
+class Key(BaseModel):
+    """Utility class for creating keys."""
+
+    prefix: str
+    rand_uuid: str
+
+    def __init__(self, prefix: str = ""):
+        """Constructor.
+
+        Args:
+            prefix (str): Prefix of the token. Default empty.
+        """
+        rand_uuid = uuid.uuid4()
+
+        super().__init__(prefix=prefix, rand_uuid=str(rand_uuid))
+
+    def get_value(self) -> str:
+        """Get the token as a string.
+
+        Returns:
+            str: The token string.
+        """
+        if len(self.prefix) > 0:
+            value = self.prefix + "-" + self.rand_uuid
+        else:
+            value = self.rand_uuid
+
+        return value
+
+    def get_hash(self) -> str:
+        """Get the token as a hashed SHA-256 string.
+
+        Returns:
+            str: The hashed token string.
+        """
+        value = self.get_value()
+
+        hash_object = hashlib.sha256()
+        value_encoded = value.encode("utf-8")
+        hash_object.update(value_encoded)
+
+        return hash_object.hexdigest()

api_key_factory-1.0.0.dist-info/METADATA

@@ -0,0 +1,119 @@
+Metadata-Version: 2.3
+Name: api-key-factory
+Version: 1.0.0
+Summary: A simple CLI tool to generate API Key
+Project-URL: Homepage, https://gitlab.com/op_so/projects/api-key-factory
+Project-URL: Documentation, https://op_so.gitlab.io/projects/api-key-factory
+Author-email: FX Soubirou <soubirou@yahoo.fr>
+License: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1.7
+Requires-Dist: pydantic>=2.6.3
+Description-Content-Type: text/markdown
+
+# `api-key-factory`
+
+[![Software License](https://img.shields.io/badge/license-MIT-informational.svg?style=for-the-badge)](LICENSE)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release&style=for-the-badge)](https://github.com/semantic-release/semantic-release)
+[![Pipeline Status](https://gitlab.com/op_so/projects/api-key-factory/badges/main/pipeline.svg)](https://gitlab.com/op_so/projects/api-key-factory/pipelines)
+
+[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://op_so.gitlab.io/projects/api-key-factory/) Source code documentation
+
+A CLI tool to generate API keys and their corresponding [SHA-256](https://en.wikipedia.org/wiki/SHA-2) hashes. The secret part of the key is an [UUID (Universally Unique Identifier) version 4 (random)](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)).
+
+Example of generated a API key:
+
+```bash
+mykey-8590efb6-0a68-4390-8537-99a54928c669
+```
+
+```bash
+Usage: api-key-factory [OPTIONS] COMMAND [ARGS]...
+
+  A simple CLI tool to generate API keys and their corresponding SHA-256
+  hashes.
+
+Options:
+  --version  Show the version and exit.
+  --help     Show this message and exit.
+
+Commands:
+  generate  Command to generate API keys and their corresponding SHA-256...
+```
+
+## `generate`
+
+Get all files with `yaml/yml` extension from the input directory and generate the
+markdown files in the output directory.
+
+```bash
+Usage: api-key-factory generate [OPTIONS]
+
+  Command to generate API keys and their corresponding SHA-256 hashes.
+
+  Raises:     click.ClickException: Error when writing output file
+
+Options:
+  -n, --num INTEGER RANGE  Number of API keys to generate  [x>=1]
+  --help                   Show this message and exit.
+```
+
+Example:
+
+```bash
+$ api-key-factory generate
+e4feb87a-ff10-4cce-bbe2-3b9dcbeb019c   1e6d309d41b3a1b7a4855aba3382bdafcb7476db97416a7ecd9fcabe4292c5ca
+```
+
+## Installation
+
+### With `Python` environment
+
+To use:
+
+- Minimal Python version: 3.10
+
+Installation with Python `pip`:
+
+```bash
+python3 -m pip install api-key-factory
+api-key-factory --help
+```
+
+## Develpement
+
+### With [Rye](https://rye.astral.sh/)
+
+To use:
+
+- Minimal Python version: 3.10
+
+Installation documentation: [https://rye.astral.sh/guide/installation/](https://rye.astral.sh/guide/installation/)
+
+```bash
+# Set environment
+rye sync
+# Lint
+rye run lint
+# Tests
+rye run test
+# Run
+rye run api-key-factory --help
+```
+
+## Authors
+
+<!-- vale off -->
+- **FX Soubirou** - *Initial work* - [GitLab repositories](https://gitlab.com/op_so)
+<!-- vale on -->
+
+## License
+
+<!-- vale off -->
+This program is free software: you can redistribute it and/or modify it under the terms of the MIT License (MIT).
+See the [LICENSE](https://opensource.org/licenses/MIT) for details.
+<!-- vale on -->

api_key_factory-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+api_key_factory/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+api_key_factory/api_key_factory.py,sha256=ND7tLAkohaOdciN0D_Fp_AWHD7oH5B-THb5ngfHp50Q,878
+api_key_factory/factory/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+api_key_factory/factory/key.py,sha256=VhYB6xnJ0SImyi1Fx-gJoLBdx6jKy94Hj0UojvchmDY,1096
+api_key_factory-1.0.0.dist-info/METADATA,sha256=ZOvaSZwebczOY0kJV0YXq_hvIjtWUgPhYI0SrJvnUyY,3525
+api_key_factory-1.0.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+api_key_factory-1.0.0.dist-info/entry_points.txt,sha256=PP2deter2inrdochHMX1lhnf1qXh7vlmOkEx6dd4p4g,72
+api_key_factory-1.0.0.dist-info/licenses/LICENSE,sha256=6j37YDpY2ikwX8yV80eUpAGPDShonchJW9nyFpqAGKM,1095
+api_key_factory-1.0.0.dist-info/RECORD,,

api_key_factory-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any

api_key_factory-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+api-key-factory = api_key_factory.api_key_factory:cli

api_key_factory-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2024 FX Soubirou soubirou@yahoo.fr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.