derivepassphrase.git

Import initial project files
Marco Ricci

Marco Ricci commited on 2024-05-05 11:57:20
Zeige 14 geänderte Dateien mit 269 Einfügungen und 0 Löschungen.

.gitignore
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,5 @@
1 
+html/
2 
+.mypy_cache/
3 
+.pytest_cache/
4 
+__pycache__/
5 
+*.swp
LICENSE.txt
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,9 @@
1 
+MIT License
2 
+
3 
+Copyright 2024 Marco Ricci <m@the13thletter.info>
4 
+
5 
+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:
6 
+
7 
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8 
+
9 
+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.
README.md
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,21 @@
1 
+# derivepassphrase
2 
+
3 
+[![PyPI - Version](https://img.shields.io/pypi/v/derivepassphrase.svg)](https://pypi.org/project/derivepassphrase)
4 
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/derivepassphrase.svg)](https://pypi.org/project/derivepassphrase)
5 
+
6 
+-----
7 
+
8 
+## Table of Contents
9 
+
10 
+- [Installation](#installation)
11 
+- [License](#license)
12 
+
13 
+## Installation
14 
+
15 
+```console
16 
+pip install derivepassphrase
17 
+```
18 
+
19 
+## License
20 
+
21 
+`derivepassphrase` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
docs/default_fonts_only.css
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,4 @@
1 
+body {
2 
+    --md-text-font-family: var(--md-text-font,sans-serif),sans-serif;
3 
+    --md-code-font-family: var(--md-code-font,monospace),monospace;
4 
+}
docs/index.md
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1 @@
1 
+Great documentation will appear here.
docs/mkdocstrings_recommended_styles.css
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,27 @@
1 
+/* Indentation. */
2 
+div.doc-contents:not(.first) {
3 
+  padding-left: 25px;
4 
+  border-left: .05rem solid var(--md-typeset-table-color);
5 
+}
6 
+
7 
+/* Mark external links as such. */
8 
+a.external::after,
9 
+a.autorefs-external::after {
10 
+  /* https://primer.style/octicons/arrow-up-right-24 */
11 
+  mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
12 
+  -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
13 
+  content: ' ';
14 
+
15 
+  display: inline-block;
16 
+  vertical-align: middle;
17 
+  position: relative;
18 
+
19 
+  height: 1em;
20 
+  width: 1em;
21 
+  background-color: currentColor;
22 
+}
23 
+
24 
+a.external:hover::after,
25 
+a.autorefs-external:hover::after {
26 
+  background-color: var(--md-accent-fg-color);
27 
+}
0 28 
\ No newline at end of file
docs/reference.md
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1 @@
1 
+# API reference
mkdocs.yml
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,92 @@
1 
+site_name: derivepassphrase documentation
2 
+site_url: null
3 
+repo_url: https://github.com/the-13th-letter/derivepassphrase
4 
+site_description: An almost faithful Python reimplementation of James Coglan's vault.
5 
+site_author: Marco Ricci
6 
+copyright: Copyright 2024 Marco Ricci (the-13th-letter).  All rights reserved.
7 
+
8 
+docs_dir: docs
9 
+site_dir: html
10 
+extra_css:
11 
+  - mkdocstrings_recommended_styles.css
12 
+  - default_fonts_only.css
13 
+
14 
+theme:
15 
+  name: "material"
16 
+  #font: false
17 
+  font:
18 
+    text: Noto Sans
19 
+    code: Noto Mono
20 
+    #code: Inconsolata
21 
+  #palette:
22 
+  #  - media: "(prefers-color-scheme)"
23 
+  #    toggle:
24 
+  #      icon: material/brightness-auto
25 
+  #      name: Switch to light mode
26 
+  #  - media: "(prefers-color-scheme: light)"
27 
+  #    scheme: default
28 
+  #    toggle:
29 
+  #      icon: material/brightness-7
30 
+  #      name: Switch to dark mode
31 
+  #  - media: "(prefers-color-scheme: dark)"
32 
+  #    scheme: slate
33 
+  #    toggle:
34 
+  #      icon: material/brightness-4
35 
+  #      name: Switch to system preference
36 
+  icon:
37 
+    logo: material/library
38 
+  features:
39 
+    - content.code.annotate
40 
+    - navigation.tracking
41 
+    - navigation.tabs
42 
+    - navigation.prune
43 
+    - toc.follow
44 
+
45 
+plugins:
46 
+  - offline:
47 
+      enabled: true
48 
+  #- privacy:
49 
+  #    enabled: true
50 
+  - mkdocstrings:
51 
+      handlers:
52 
+        python:
53 
+          import:
54 
+            - https://docs.python.org/3/objects.inv
55 
+          options:
56 
+            docstring_options:
57 
+              ignore_init_summary: true
58 
+              returns_multiple_items: false
59 
+            heading_level: 2
60 
+            show_object_full_path: false
61 
+            show_root_members_full_path: false
62 
+            show_root_heading: true
63 
+            show_symbol_type_heading: true
64 
+            show_symbol_type_toc: true
65 
+            parameters_heading: true
66 
+            #members_order: 'source'
67 
+            show_signature_annotations: false
68 
+            separate_signature: true
69 
+            signature_crossrefs: false
70 
+            unwrap_annotated: true
71 
+          paths:
72 
+            - src
73 
+
74 
+nav:
75 
+  - derivepassphrase documentation: index.md
76 
+  #- tutorials.md
77 
+  #- How-Tos: how-tos.md
78 
+  - Reference: reference.md
79 
+  #- explanation.md
80 
+
81 
+markdown_extensions:
82 
+  - abbr
83 
+  - attr_list
84 
+  - def_list
85 
+  - footnotes
86 
+  - admonition
87 
+  - smarty
88 
+  - toc:
89 
+      permalink: true
90 
+  - pymdownx.superfences
91 
+  - pymdownx.tabbed:
92 
+      alternate_style: true
pyproject.toml
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,77 @@
1 
+[build-system]
2 
+requires = ["hatchling"]
3 
+build-backend = "hatchling.build"
4 
+
5 
+[project]
6 
+name = "derivepassphrase"
7 
+dynamic = ["version"]
8 
+description = "An almost faithful Python reimplementation of James Coglan's vault."
9 
+readme = "README.md"
10 
+requires-python = ">=3.11"
11 
+license = "MIT"
12 
+keywords = []
13 
+authors = [
14 
+  { name = "Marco Ricci", email = "m@the13thletter.info" },
15 
+]
16 
+classifiers = [
17 
+  "Development Status :: 4 - Beta",
18 
+  "Environment :: Console",
19 
+  "Programming Language :: Python :: 3",
20 
+  "Programming Language :: Python :: 3 :: Only",
21 
+  "Programming Language :: Python :: 3.11",
22 
+  "Programming Language :: Python :: 3.12",
23 
+  "Programming Language :: Python :: Implementation :: CPython",
24 
+  "Programming Language :: Python :: Implementation :: PyPy",
25 
+]
26 
+dependencies = [
27 
+  "click",
28 
+]
29 
+
30 
+[project.urls]
31 
+Documentation = "https://github.com/the-13th-letter/derivepassphrase#readme"
32 
+Issues = "https://github.com/the-13th-letter/derivepassphrase/issues"
33 
+Source = "https://github.com/the-13th-letter/derivepassphrase"
34 
+
35 
+[project.scripts]
36 
+derivepassphrase = "derivepassphrase.cli:derivepassphrase"
37 
+
38 
+[tool.mypy]
39 
+mypy_path = '$MYPY_CONFIG_FILE_DIR/src'
40 
+explicit_package_bases = true
41 
+implicit_reexport = false
42 
+sqlite_cache = true
43 
+
44 
+[tool.pytest.ini_options]
45 
+addopts = '--doctest-modules'
46 
+pythonpath = ['src']
47 
+testpaths = ['tests']
48 
+xfail_strict = true
49 
+
50 
+[tool.hatch.version]
51 
+path = "src/derivepassphrase/__about__.py"
52 
+
53 
+[tool.hatch.envs.types]
54 
+extra-dependencies = [
55 
+  "mypy>=1.0.0",
56 
+]
57 
+[tool.hatch.envs.types.scripts]
58 
+check = "mypy --install-types --non-interactive {args:src/derivepassphrase tests}"
59 
+
60 
+[tool.coverage.run]
61 
+source_pkgs = ["derivepassphrase", "tests"]
62 
+branch = true
63 
+parallel = true
64 
+omit = [
65 
+  "src/derivepassphrase/__about__.py",
66 
+]
67 
+
68 
+[tool.coverage.paths]
69 
+derivepassphrase = ["src/derivepassphrase", "*/derivepassphrase/src/derivepassphrase"]
70 
+tests = ["tests", "*/derivepassphrase/tests"]
71 
+
72 
+[tool.coverage.report]
73 
+exclude_lines = [
74 
+  "no cov",
75 
+  "if __name__ == .__main__.:",
76 
+  "if TYPE_CHECKING:",
77 
+]
src/derivepassphrase/__about__.py
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,5 @@
1 
+# SPDX-FileCopyrightText: 2024 Marco Ricci <m@the13thletter.info>
2 
+#
3 
+# SPDX-License-Identifier: MIT
4 
+__version__ = "0.0.1"
5 
+__author__ = "Marco Ricci <m@the13thletter.info>"
src/derivepassphrase/__init__.py
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,3 @@
1 
+# SPDX-FileCopyrightText: 2024 Marco Ricci <m@the13thletter.info>
2 
+#
3 
+# SPDX-License-Identifier: MIT
src/derivepassphrase/__main__.py
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,9 @@
1 
+# SPDX-FileCopyrightText: 2024 Marco Ricci <m@the13thletter.info>
2 
+#
3 
+# SPDX-License-Identifier: MIT
4 
+import sys
5 
+
6 
+if __name__ == "__main__":
7 
+    from derivepassphrase.cli import derivepassphrase
8 
+
9 
+    sys.exit(derivepassphrase())
src/derivepassphrase/cli/__init__.py
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,12 @@
1 
+# SPDX-FileCopyrightText: 2024 Marco Ricci <m@the13thletter.info>
2 
+#
3 
+# SPDX-License-Identifier: MIT
4 
+import click
5 
+
6 
+from derivepassphrase.__about__ import __version__
7 
+
8 
+
9 
+@click.group(context_settings={"help_option_names": ["-h", "--help"]}, invoke_without_command=True)
10 
+@click.version_option(version=__version__, prog_name="derivepassphrase")
11 
+def derivepassphrase():
12 
+    click.echo("Hello world!")
tests/__init__.py
Zeige Datei @ 16c26e1
... ... 
@@ -0,0 +1,3 @@
1 
+# SPDX-FileCopyrightText: 2024 Marco Ricci <m@the13thletter.info>
2 
+#
3 
+# SPDX-License-Identifier: MIT
0 4