cappysan-dotfile-scripts 0.0.0__tar.gz

cappysan_dotfile_scripts-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025-2025, Julien Lecomte
+
+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.

cappysan_dotfile_scripts-0.0.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include LICENSE
+include README.md
+include constraints.txt
+include py.typed
+include pyproject.toml
+include requirements*.txt
+include setup.*
+
+recursive-include dotfiles/ *
+
+prune docs
+prune examples
+prune tests

cappysan_dotfile_scripts-0.0.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: cappysan-dotfile-scripts
+Version: 0.0.0
+Author-email: Julien Lecomte <julien@cappysan.dev>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/cappysan/dotfiles/dotfiles
+Project-URL: Source code, https://gitlab.com/cappysan/dotfiles/dotfiles
+Project-URL: Bug tracker, https://gitlab.com/cappysan/dotfiles/dotfiles
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Dynamic: license-file

cappysan_dotfile_scripts-0.0.0/bin/clear

@@ -0,0 +1,20 @@
+#!/usr/bin/env sh
+# ──────────────────────────────────────────────────────────────────────────────
+# $source: cappysan-dotfile-scripts$
+# ──────────────────────────────────────────────────────────────────────────────
+#
+# NAME
+#      clear - clear the terminal with any method available
+#
+# SEE ALSO
+#      clear_console(1), clear(1)
+#
+if test -x /usr/bin/clear_console; then
+  if /usr/bin/clear_console -q "${@}"; then
+    exit 0
+  fi
+fi
+
+if test -x /usr/bin/clear; then
+  /usr/bin/clear "${@}"
+fi

cappysan_dotfile_scripts-0.0.0/cappysan_dotfile_scripts.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: cappysan-dotfile-scripts
+Version: 0.0.0
+Author-email: Julien Lecomte <julien@cappysan.dev>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/cappysan/dotfiles/dotfiles
+Project-URL: Source code, https://gitlab.com/cappysan/dotfiles/dotfiles
+Project-URL: Bug tracker, https://gitlab.com/cappysan/dotfiles/dotfiles
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Dynamic: license-file

cappysan_dotfile_scripts-0.0.0/cappysan_dotfile_scripts.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+LICENSE
+MANIFEST.in
+README.md
+constraints.txt
+pyproject.toml
+requirements-dev.txt
+requirements.txt
+setup.py
+bin/clear
+cappysan_dotfile_scripts.egg-info/PKG-INFO
+cappysan_dotfile_scripts.egg-info/SOURCES.txt
+cappysan_dotfile_scripts.egg-info/dependency_links.txt
+cappysan_dotfile_scripts.egg-info/requires.txt
+cappysan_dotfile_scripts.egg-info/top_level.txt
+cappysan_dotfile_scripts.egg-info/zip-safe
+dotfiles/__init__.py
+dotfiles/__main__.py
+dotfiles/constants.py
+dotfiles/testing/__init__.py

cappysan_dotfile_scripts-0.0.0/cappysan_dotfile_scripts.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cappysan_dotfile_scripts-0.0.0/cappysan_dotfile_scripts.egg-info/requires.txt

@@ -0,0 +1,2 @@
+
+[dev]

cappysan_dotfile_scripts-0.0.0/cappysan_dotfile_scripts.egg-info/top_level.txt

@@ -0,0 +1 @@
+dotfiles

cappysan_dotfile_scripts-0.0.0/cappysan_dotfile_scripts.egg-info/zip-safe

@@ -0,0 +1 @@
+

cappysan_dotfile_scripts-0.0.0/constraints.txt

@@ -0,0 +1,2 @@
+# This file was autogenerated by uv via the following command:
+#    uv pip compile requirements.txt --format requirements.txt -o requirements.txt

cappysan_dotfile_scripts-0.0.0/dotfiles/__main__.py

@@ -0,0 +1,2 @@
+def main():
+    pass

cappysan_dotfile_scripts-0.0.0/dotfiles/constants.py

@@ -0,0 +1 @@
+VERSION = "0.0.0"

cappysan_dotfile_scripts-0.0.0/pyproject.toml

@@ -0,0 +1,310 @@
+# Project metadata guidelines:
+#   https://peps.python.org/pep-0621/
+#
+# ------------------------------------------------------------------------------
+# Setup
+# ------------------------------------------------------------------------------
+[project]
+dynamic = ["dependencies"]
+
+name = "cappysan-dotfile-scripts"
+version = "0.0.0"
+authors = [
+  {name = "Julien Lecomte", email = "julien@cappysan.dev"}
+]
+readme  = "README.md"
+description = ""
+license = "MIT"
+
+# See: https://pypi.python.org/pypi?:action=list_classifiers
+# List of python versions and their support status: https://devguide.python.org/versions/
+requires-python = ">=3.10"
+classifiers = [
+  "Intended Audience :: Developers",
+#  "Development Status :: 5 - Production/Stable",
+  "Programming Language :: Python :: 3 :: Only",
+]
+
+
+[project.scripts]
+# dotfiles-install = "dotfiles:main"
+
+
+[project.optional-dependencies]
+dev = []
+
+
+[project.urls]
+Homepage = "https://gitlab.com/cappysan/dotfiles/dotfiles"
+"Source code" = "https://gitlab.com/cappysan/dotfiles/dotfiles"
+"Bug tracker" = "https://gitlab.com/cappysan/dotfiles/dotfiles"
+
+
+[tool.setuptools]
+packages = [
+  "dotfiles",
+  "dotfiles.testing",
+]
+zip-safe = true
+script-files = [
+  "bin/clear",
+]
+
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+
+[build-system]
+# These are the assumed default build requirements from pip:
+# https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support
+requires = ["setuptools>=53.0.0"]
+
+# ------------------------------------------------------------------------------
+# Other tools
+# ------------------------------------------------------------------------------
+[tool.autoflake]
+# https://pypi.org/project/pyproject-autoflake/
+in-place = true
+# Use '# noqa: F401' to ignore a removal
+remove-all-unused-imports = true
+ignore-init-module-imports = true
+remove-duplicate-keys = true
+remove-unused-variables = true
+ignore-pass-after-docstring = true
+
+
+[tool.black]
+line-length = 120
+target_version = ["py310", "py311", "py312", "py313", "py314"]
+
+
+[tool.bumpversion]
+current_version = "0.0.0"
+parse = """(?x)
+  (?P<major>0|[1-9]\\d*)\\.
+  (?P<minor>0|[1-9]\\d*)\\.
+  (?P<patch>0|[1-9]\\d*)
+  (?:
+    -                               # dash separator for pre-release section
+    (?P<seg_l>alpha|beta|rc|post)   # pre-release label
+    (?:(?P<seg_n>0|[1-9]\\d*))      # pre-release version number
+  )?                                # pre-release section is optional
+"""
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+ignore_missing_files = false
+tag = true
+sign_tags = true
+tag_name = "{new_version}"
+tag_message = "Bump version from {current_version} to {new_version}"
+allow_dirty = false
+commit = true
+message = "Release version {new_version} (previous: {current_version})"
+moveable_tags = []
+commit_args = ""
+setup_hooks = []
+pre_commit_hooks = [
+  "precommit run --all",
+]
+post_commit_hooks = []
+
+serialize = [
+  "{major}.{minor}.{patch}-{seg_l}{seg_n}",
+  "{major}.{minor}.{patch}",
+]
+
+[tool.bumpversion.parts.seg_l]
+values = [ "alpha", "beta", "rc", "post"]
+optional_value = "post"
+
+[tool.bumpversion.parts.seg_n]
+first_value = "1"
+
+[[tool.bumpversion.files]]
+filename = ".answers.yml"
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+
+[[tool.bumpversion.files]]
+filename = "src/constants.py"
+
+
+[tool.codespell]
+# https://github.com/codespell-project/codespell/blob/main/README.rst
+#
+# Dictionary is updated when codespell is updated, nevertheless, it can
+# be found here: .venv/lib/python3.*/site-packages/codespell_lib/data/dictionary.txt
+skip = "*.pyc,.cache,.git,.tox,.venv,public"
+builtin = "clear,informal,rare,names"
+ignore-words = "support/codespell.exclude"
+ignore-multiline-regex = "# codespell: off\n.*# codespell: on\n"
+check-filenames = ""
+
+[tool.coverage.run]
+branch = true
+parallel = true
+omit = [
+  "bin/*",
+  "docs/*",
+  "examples/*",
+  "tests/*",
+]
+
+
+[tool.coverage.report]
+# pragma: no cover:             disable coverage for a line
+# pragma: no cover: start|stop: disable coverage for a block
+# pragma: exclude file:         disable coverage for a file
+show_missing = true
+exclude_lines = [
+  "@abc.abstractmethod",
+  "@abc.abstractproperty",
+  "_typeshed",
+  "except ImportError",
+  "if False",
+  "if __name__ == .__main__.:",
+  "lambda: None",
+  "pragma: no cover",
+  "raise NotImplemented",
+  "raise NotImplementedError",
+  "return NotImplemented",
+  "t.TYPE_CHECKING",
+]
+exclude_also = [
+  'no cover: start(?s:.)*?no cover: stop',
+  '\A(?s:.*# pragma: exclude file.*)\Z',
+]
+
+
+[tool.isort]
+# https://pycqa.github.io/isort/docs/configuration/options.html
+profile = "black"
+line_length = 120
+atomic = true
+include_trailing_comma = true
+skip_gitignore = true
+use_parentheses = true
+known_local_folder = "tests"
+
+
+[tool.mypy]
+# https://mypy.readthedocs.io/en/stable/config_file.html
+pretty = true
+strict = true
+
+implicit_optional = true
+ignore_missing_imports = true
+
+warn_return_any = true
+warn_unused_configs = true
+
+disallow_untyped_calls = false
+
+exclude = [
+  '^bin\/.*',
+  '^docs\/.*',
+  '^setup.py$',
+  '^tests\/.*',
+]
+
+[tool.nitpick]
+style = [
+  # Ensure this project is up-to-date with template.
+  "https://gitlab.com/cappysan/scaffolds/python-template/-/raw/main/nitpick/scaffold-tpl-version-check.toml",
+  #
+  "https://gitlab.com/cappysan/nitpick/-/raw/main/resources/nitpick.toml",
+  "https://gitlab.com/cappysan/nitpick/-/raw/main/resources/pre-commit.toml",
+]
+ignore_styles = []
+
+[tool.pylint.main]
+
+[tool.pylint.reports]
+# Deactivate the evaluation score.
+score = false
+
+[tool.pylint.exceptions]
+# Exceptions that will emit a warning when caught.
+overgeneral-exceptions = "builtins.BaseException"
+
+[tool.pylint."messages control"]
+# Disable the message, report, category or checker with the given id(s). You can
+# either give multiple identifiers separated by comma (,) or put this option
+# multiple times (only on the command line, not in the configuration file where
+# it should appear only once). You can also use "--disable=all" to disable
+# everything first and then re-enable specific checks. For example, if you want
+# to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
+disable = [
+  "raw-checker-failed",
+  "bad-inline-option",
+  "locally-disabled",
+  "file-ignored",
+  "suppressed-message",
+  "useless-suppression",
+  "deprecated-pragma",
+  "use-symbolic-message-instead",
+  # defaults above, custom below
+  "chained-comparison",            # disabled, less readable by habit
+  "duplicate-code",                # disabled, false positives
+  "fixme",                         # disabled, can be properly handled manually
+  "line-too-long",                 # disabled, we use black so lines over 120 are intended
+  "logging-fstring-interpolation", # disabled, benefit outweighs cost
+  "missing-class-docstring",       # disabled, only relevant with sphinx
+  "missing-function-docstring",    # disabled, only relevant with sphinx
+  "missing-kwoa",                  # disabled, false positives
+  "missing-module-docstring",      # disabled, only relevant with sphinx
+  "no-member",                     # disabled, false positives
+  "too-few-public-methods",        # disabled, human knows best
+  "too-many-arguments",            # disabled, human knows best
+  "too-many-branches",             # disabled, human knows best
+  "too-many-instance-attributes",  # disabled, human knows best
+  "too-many-locals",               # disabled, human knows best
+  "too-many-statements",           # disabled, human knows best
+  "ungrouped-imports",             # disabled, we use isort so this is only voluntary
+  "wrong-import-order",            # disabled, we use isort so this is only voluntary
+  # local to this project:
+]
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where it
+# should appear only once). See also the "--disable" option for examples.
+enable = ["c-extension-no-member"]
+
+[tool.pylint.basic]
+# If variable isn't whitelisted here, it'll trigger an 'invalid-name' error
+good-names = [
+  "i",
+  "j",
+  "k",
+  "ex",
+  "Run",
+  "_",
+  # defaults above, custom below
+  "app", # application
+  "db",  # database
+  "fd",  # file descriptor
+  "fn",  # function (reserved word)
+  "rv",  # frequently used as 'retval', aka 'return value'
+  "v",   # as in `for k, v in {}.items()`
+  "x",   # frequently used in lambdas, more precise than i, j
+  "pk",  # used as primary key for API
+  # local to this project:
+]
+
+# Good variable names regexes, separated by a comma. If names match any regex,
+# they will always be accepted
+good-names-rgxs = "^_?(CONST_|K_)[A-Z0-9][_A-Z0-9]*$"
+
+
+[tool.pytest.ini_options]
+markers = [
+   "live: connects to internet resource (unselect with '-m \"not live\"')",
+]

cappysan_dotfile_scripts-0.0.0/requirements-dev.txt

@@ -0,0 +1,14 @@
+-r requirements.txt
+
+mock
+pylint
+pytest
+pytest-cov
+pytest-html
+pytest-mock
+pytest-order
+
+
+build
+setuptools
+twine

cappysan_dotfile_scripts-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cappysan_dotfile_scripts-0.0.0/setup.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python3
+# pylint: disable=redefined-outer-name
+#
+import os
+import shutil
+import subprocess
+import tempfile
+import typing as t
+
+from setuptools import setup
+
+try:
+    import tomlib
+except ModuleNotFoundError:
+    try:
+        import tomllib as tomlib
+    except ModuleNotFoundError:
+        import tomli as tomlib
+
+
+class AutoRestoreFile:
+    def __init__(self, src: str, dst: str):
+        self.src = src
+        self.dst = dst
+
+    def __enter__(self) -> None:
+        shutil.copyfile(self.src, self.dst)
+
+    def __exit__(self, _exc_type: t.Any, _exc_value: t.Any, _exc_traceback: t.Any) -> None:
+        shutil.copyfile(self.dst, self.src)
+
+
+def load_requirements() -> list[str]:
+    with open("requirements.txt", encoding="UTF-8") as fd:
+        requirements = fd.read().splitlines()
+        requirements = [x for x in requirements if x and not x.startswith("--")]
+    return requirements
+
+
+def save_requirements(requirements: list[str]) -> None:
+    with open("requirements.txt", mode="w", encoding="UTF-8") as fd:
+        fd.writelines([f"{x}\n" for x in requirements])
+
+
+def push_requirements() -> None:
+    # requirements.txt support flags such as "--index", remove
+    # them before we continue
+    requirements = load_requirements()
+    save_requirements(requirements)
+
+
+def freeze_requirements() -> None:
+    # If pyproject specifies creating script files, then
+    # compile a static version of the dependencies.
+
+    # Does the pyproject.toml have a "project.scripts"?
+    config = os.path.dirname(__file__) + "/pyproject.toml"
+    with open(config, mode="rb") as fd:
+        pyproject = tomlib.load(fd)
+
+    if not pyproject["project"].get("scripts"):
+        return
+
+    cmdline = "uv pip compile requirements.txt --format requirements.txt -o requirements.txt"
+    retval = subprocess.run(cmdline, shell=True, check=True, capture_output=True)
+    retval.check_returncode()
+
+    # Make a copy as a `constraints.txt` file so it can be used optionally for dev
+    shutil.copyfile("requirements.txt", "constraints.txt")
+
+
+with tempfile.NamedTemporaryFile() as tmpfile:
+    with AutoRestoreFile("requirements.txt", tmpfile.name):
+        push_requirements()
+        freeze_requirements()
+        setup()