crackerjack 0.3.3__tar.gz → 0.7.30__tar.gz

{crackerjack-0.3.3 → crackerjack-0.7.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: crackerjack
-Version: 0.3.3
+Name: Crackerjack
+Version: 0.7.30
 Summary: Crackerjack code style
 Keywords: black ruff mypy creosote refurb
 Home-page: https://github.com/lesleslie/crackerjack
@@ -10,27 +10,39 @@ License: BSD-3-Clause
 Classifier: Environment :: Console
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Utilities
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Typing :: Typed
 Project-URL: Homepage, https://github.com/lesleslie/crackerjack
 Project-URL: Documentation, https://github.com/lesleslie/crackerjack
 Project-URL: Repository, https://github.com/lesleslie/crackerjack
-Requires-Python: >=3.11
-Requires-Dist: click>=8.1.3
-Requires-Dist: aiopath>=0.6.11
-Requires-Dist: aioconsole>=0.6.1
-Requires-Dist: pydantic>=2.0b2
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1.7
+Requires-Dist: aioconsole>=0.7.0
 Requires-Dist: inflection>=0.5.1
-Requires-Dist: acb>=0.1.8
-Requires-Dist: tomli-w>=1.0.0
-Requires-Dist: pdm-bump>=0.7.0
+Requires-Dist: autotyping>=23.3.0
+Requires-Dist: pre-commit>=3.6.0
+Requires-Dist: pytest>=7.4.3
+Requires-Dist: pydantic>=2.5.3
+Requires-Dist: aiopath>=0.7.7
+Requires-Dist: acb>=0.4.0
+Requires-Dist: pdm-bump>=0.7.3
+Requires-Dist: pdm>=2.12.3
 Description-Content-Type: text/markdown
 
 # Crackerjack Python
 
-[![Python: 3.11](https://img.shields.io/badge/python-3.11%2B-blue)](https://docs.python.org/3/)
+[![Python: 3.12](https://img.shields.io/badge/python-3.12%2B-blue)](https://docs.python.org/3/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
 [![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
 [![Code style: crackerjack](https://img.shields.io/badge/code%20style-crackerjack-000042)](https://github.com/lesleslie/crackerjack)
 
 Crackerjack is a python coding style which uses a minimalist approach to produce elegant, easy to read, code.
@@ -80,22 +92,21 @@ This package:
 
 - streamlines and standardizes code style across numerous packages
 
-- removes pipenv, poetry, and hatch build, dependency management, and virtual environment
-  management packages and replaces them with PDM using PEP-582 (work in progress)
-
 - installs, or updates, a project's pre-commit tools as well as .gitignore & other config files
   to comply with evolving crackerjack standards
 
 - runs the following pre-commit hooks (in order):
-  * various core pre-commit hooks
-  * [black](https://github.com/ambv/black)
-  * ruff
-  * creosote
-  * flynt
-  * pyanalyze
-  * autotyping
-  * refurb
-  * pyright
+  * [pdm-lock-check](https://github.com/pdm-project/pdm)
+  * various core [pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks)
+  * [black](https://github.com/psf/black)
+  * [ruff](https://github.com/charliermarsh/ruff-pre-commit)
+  * [creosote](https://github.com/fredrikaverpil/creosote)
+  * [flynt](https://github.com/ikamensh/flynt/)
+  * [codespell](https://github.com/codespell-project/codespell)
+  * [autotyping](https://github.com/JelleZijlstra/autotyping)
+  * [refurb](https://github.com/dosisod/refurb)
+  * [bandit](https://github.com/PyCQA/bandit)
+  * [pyright](https://github.com/RobertCraigie/pyright-python)
   * ruff (again for sanity checking)
   * black (again for sanity checking)
 
@@ -126,11 +137,9 @@ This package:
 
 - functions that deal with path operations should get passed AsyncPaths or Paths - not strings
 
-- if a class can be a dataclasses.dataclass, pydantic.BaseModel, or msgspec.Struct it should be
-
 - force single line imports (will support isort Vertical Hanging Indent when ruff does)
 
-- use PDM and PEP-582 for dependency management and package building/publishing
+- use PDM and PEP-582(proposed) for dependency management and package building/publishing
 
 - use pdoc and mkdocs for producing documentation
 

{crackerjack-0.3.3 → crackerjack-0.7.30}/README.md

@@ -1,9 +1,10 @@
 # Crackerjack Python
 
-[![Python: 3.11](https://img.shields.io/badge/python-3.11%2B-blue)](https://docs.python.org/3/)
+[![Python: 3.12](https://img.shields.io/badge/python-3.12%2B-blue)](https://docs.python.org/3/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
 [![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
 [![Code style: crackerjack](https://img.shields.io/badge/code%20style-crackerjack-000042)](https://github.com/lesleslie/crackerjack)
 
 Crackerjack is a python coding style which uses a minimalist approach to produce elegant, easy to read, code.
@@ -53,22 +54,21 @@ This package:
 
 - streamlines and standardizes code style across numerous packages
 
-- removes pipenv, poetry, and hatch build, dependency management, and virtual environment
-  management packages and replaces them with PDM using PEP-582 (work in progress)
-
 - installs, or updates, a project's pre-commit tools as well as .gitignore & other config files
   to comply with evolving crackerjack standards
 
 - runs the following pre-commit hooks (in order):
-  * various core pre-commit hooks
-  * [black](https://github.com/ambv/black)
-  * ruff
-  * creosote
-  * flynt
-  * pyanalyze
-  * autotyping
-  * refurb
-  * pyright
+  * [pdm-lock-check](https://github.com/pdm-project/pdm)
+  * various core [pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks)
+  * [black](https://github.com/psf/black)
+  * [ruff](https://github.com/charliermarsh/ruff-pre-commit)
+  * [creosote](https://github.com/fredrikaverpil/creosote)
+  * [flynt](https://github.com/ikamensh/flynt/)
+  * [codespell](https://github.com/codespell-project/codespell)
+  * [autotyping](https://github.com/JelleZijlstra/autotyping)
+  * [refurb](https://github.com/dosisod/refurb)
+  * [bandit](https://github.com/PyCQA/bandit)
+  * [pyright](https://github.com/RobertCraigie/pyright-python)
   * ruff (again for sanity checking)
   * black (again for sanity checking)
 
@@ -99,11 +99,9 @@ This package:
 
 - functions that deal with path operations should get passed AsyncPaths or Paths - not strings
 
-- if a class can be a dataclasses.dataclass, pydantic.BaseModel, or msgspec.Struct it should be
-
 - force single line imports (will support isort Vertical Hanging Indent when ruff does)
 
-- use PDM and PEP-582 for dependency management and package building/publishing
+- use PDM and PEP-582(proposed) for dependency management and package building/publishing
 
 - use pdoc and mkdocs for producing documentation
 

{crackerjack-0.3.3 → crackerjack-0.7.30}/crackerjack/.gitignore

@@ -7,7 +7,8 @@
 /dist/
 /.mypy_cache/
 /.ruff_cache/
-/.crackerjack-config.yaml
-/.pyanalyze-report.json
-/.pyanalyze-report.md
 /.pdm-build/
+/tmp/
+/__pycache__/
+/*.pyc
+/.crackerjack.yaml

{crackerjack-0.3.3 → crackerjack-0.7.30}/crackerjack/.pre-commit-config.yaml

@@ -1,13 +1,13 @@
 repos:
   - repo: https://github.com/pdm-project/pdm
-    rev: 2.7.4  # a PDM release exposing the hook
+    rev: 2.13.2  # a PDM release exposing the hook
     hooks:
       - id: pdm-lock-check
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
-        name: trailing-whitspace
+        name: trailing-whitespace
       - id: end-of-file-fixer
         name: end-of-file-fixer
       - id: check-yaml
@@ -17,38 +17,27 @@ repos:
       - id: check-added-large-files
         name: check-added-large-files
   - repo: https://github.com/psf/black
-    rev: '23.3.0'
+    rev: '24.3.0'
     hooks:
       - id: black
-        language_version: python3.11
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.272
+    rev: v0.3.5
     hooks:
       - id: ruff
   - repo: https://github.com/fredrikaverpil/creosote
-    rev: v2.6.2
+    rev: v3.0.0
     hooks:
       - id: creosote
-        args: [--paths, "crackerjack", --exclude-deps, "pdm-bump", "tomli-w"]
   - repo: https://github.com/ikamensh/flynt/
-    rev: '0.78'
+    rev: '1.0.1'
     hooks:
       - id: flynt
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.4
+    rev: v2.2.6
     hooks:
       - id: codespell
         additional_dependencies:
           - tomli
-  - repo: local
-    hooks:
-      - id: pyanalyze
-        name: pyanalyze
-        entry: python -m pyanalyze
-        language: python
-        files: \.py$
-        additional_dependencies:
-          - pyanalyze>=0.10.1
   - repo: local
     hooks:
       - id: autotyping
@@ -60,7 +49,6 @@ repos:
           - --show-successes
           - --include-generated
           - --guess-common-names
-          - --pyanalyze-report '.pyanalyze-report.json',
           - crackerjack
         types_or: [ python, pyi ]
         language: python
@@ -69,13 +57,26 @@ repos:
           - autotyping>=23.3.0
           - libcst>=0.4.9
   - repo: https://github.com/dosisod/refurb
-    rev: v1.16.0
+    rev: v2.0.0
     hooks:
       - id: refurb
+  - repo: https://github.com/PyCQA/bandit
+    rev: '1.7.8'
+    hooks:
+      - id: bandit
+        args: ["-c", "pyproject.toml"]
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.313
+    rev: v1.1.356
     hooks:
       - id: pyright
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.3.5
+    hooks:
+      - id: ruff
+  - repo: https://github.com/psf/black
+    rev: '24.3.0'
+    hooks:
+      - id: black
   #  - repo: https://github.com/pdoc3/pdoc
   #    rev: master
   #    hooks:
@@ -86,18 +87,3 @@ repos:
   #        require_serial: true
   #        types: [ python ]
   #        always_run: true
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.272
-    hooks:
-      - id: ruff
-  - repo: https://github.com/psf/black
-    rev: '23.3.0'
-    hooks:
-      - id: black
-        language_version: python3.11
-  - repo: https://github.com/pdm-project/pdm
-    rev: 2.7.4 # a PDM release exposing the hook
-    hooks:
-      - id: pdm-export
-        args: [ '-o', 'requirements.txt', '--without-hashes' ]
-        files: ^pdm.lock$

{crackerjack-0.3.3 → crackerjack-0.7.30}/crackerjack/__main__.py

@@ -1,4 +1,5 @@
 import asyncio
+import typing as t
 
 from click import command
 from click import help_option
@@ -12,7 +13,8 @@ class Options(BaseModel):
     interactive: bool = False
     doc: bool = False
     do_not_update_configs: bool = False
-    publish: str | bool = False
+    publish: t.Literal["micro", "minor", "major"] | bool = False
+    bump: t.Literal["micro", "minor", "major"] | bool = False
     verbose: bool = False
     update_precommit: bool = False
 
@@ -28,9 +30,19 @@ options = Options()
 @option("-x", is_flag=True, help="do not update configs")
 @option("-u", is_flag=True, help="update pre-commit")
 @option("-v", is_flag=True, help="verbose")
-@option("-p", help="publish: -p [micro, minor, major]")
+@option("-p", help="bump version and publish: -p [micro, minor, major]")
+@option("-b", help="bump version: -b [micro, minor, major]")
 # @option("-f", help="format: -f [module]")
-def crackerjack(c: bool, i: bool, d: bool, u: bool, v: bool, x: bool, p: str) -> None:
+def crackerjack(
+    c: bool = False,
+    i: bool = False,
+    d: bool = False,
+    u: bool = False,
+    v: bool = False,
+    x: bool = False,
+    p: str | bool = False,
+    b: str | bool = False,
+) -> None:
     if c:
         options.commit = c
     if i:
@@ -43,10 +55,12 @@ def crackerjack(c: bool, i: bool, d: bool, u: bool, v: bool, x: bool, p: str) ->
         options.do_not_update_configs = x
     if p in ("micro", "minor", "major"):
         options.publish = p
+    if b in ("micro", "minor", "major"):
+        options.bump = b
     if v:
         print("-v not currently implemented")
         options.verbose = v
-    asyncio.run(crackerjack_it(options))
+    asyncio.run(crackerjack_it(options=options))
 
 
 if __name__ == "__main__":

crackerjack-0.7.30/crackerjack/crackerjack.py

@@ -0,0 +1,195 @@
+import asyncio
+import re
+import sys
+import typing as t
+from pathlib import Path
+from subprocess import run
+
+from acb.actions.encode import dump
+from acb.actions.encode import load
+from aioconsole import ainput
+from aioconsole import aprint
+from aiopath import AsyncPath
+from inflection import underscore
+from pydantic import BaseModel
+
+
+class Config(BaseModel):
+    python_version: t.Optional[str] = None
+    pre_commit_path: t.Optional[Path] = None
+    git_path: t.Optional[Path] = None
+    pdm_path: t.Optional[Path] = None
+    zshenv_path: t.Optional[Path] = None
+
+
+class Crackerjack(BaseModel, arbitrary_types_allowed=True):
+    our_path: AsyncPath = AsyncPath(__file__).parent
+    pkg_path: AsyncPath = AsyncPath(Path.cwd())
+    settings_path: AsyncPath = pkg_path / ".crackerjack.yaml"
+    pkg_dir: t.Optional[AsyncPath] = None
+    pkg_name: str = "crackerjack"
+    our_toml: t.Optional[dict[str, t.Any]] = None
+    pkg_toml: t.Optional[dict[str, t.Any]] = None
+    our_toml_path: t.Optional[AsyncPath] = None
+    pkg_toml_path: t.Optional[AsyncPath] = None
+    config: t.Optional[Config] = None
+
+    async def update_pyproject_configs(self) -> None:
+        toml_file = "pyproject.toml"
+        self.our_toml_path = self.our_path / toml_file
+        self.pkg_toml_path = self.pkg_path / toml_file
+        if self.pkg_path.stem == "crackerjack":
+            await self.our_toml_path.write_text(await self.pkg_toml_path.read_text())
+            return
+        our_toml_config: t.Any = await load.toml(self.our_toml_path)  # type: ignore
+        pkg_toml_config: t.Any = await load.toml(self.pkg_toml_path)  # type: ignore
+        pkg_deps = pkg_toml_config["tool"]["pdm"]["dev-dependencies"]
+        for tool, settings in our_toml_config["tool"].items():
+            for setting, value in settings.items():
+                if isinstance(value, str | list) and "crackerjack" in value:
+                    if isinstance(value, list):
+                        value.remove("crackerjack")
+                        value.append(self.pkg_name)
+                    else:
+                        value = value.replace("crackerjack", self.pkg_name)
+                    settings[setting] = value
+                if setting in (
+                    "exclude-deps",
+                    "exclude",
+                    "excluded",
+                    "skips",
+                    "ignore",
+                ) and isinstance(value, list):
+                    settings[setting] = set(
+                        pkg_toml_config["tool"][tool][setting] + value
+                    )
+            pkg_toml_config["tool"][tool] = settings
+        pkg_toml_config["tool"]["pdm"]["dev-dependencies"] = pkg_deps
+        python_version_pattern = r"\s*W*(\d\.\d*)"
+        requires_python = our_toml_config["project"]["requires-python"]
+        classifiers = []
+        for classifier in pkg_toml_config["project"]["classifiers"]:
+            classifier = re.sub(
+                python_version_pattern, f" {self.config.python_version}", classifier
+            )
+            classifiers.append(classifier)
+        pkg_toml_config["project"]["classifiers"] = classifiers
+        pkg_toml_config["project"]["requires-python"] = requires_python
+        await dump.toml(pkg_toml_config, self.pkg_toml_path)  # type: ignore
+
+    async def copy_configs(self) -> None:
+        config_files = (
+            ".gitignore",
+            ".pre-commit-config.yaml",
+            ".libcst.codemod.yaml",
+        )
+        for config in config_files:
+            config_path = self.our_path / config
+            pkg_config_path = self.pkg_path / config
+            await pkg_config_path.touch(exist_ok=True)
+            if self.pkg_path.stem == "crackerjack":
+                await config_path.write_text(await pkg_config_path.read_text())
+                continue
+            config_text = await config_path.read_text()
+            if config == ".gitignore":
+                await pkg_config_path.write_text(
+                    config_text.replace("crackerjack", self.pkg_name)
+                )
+            run([str(self.config.git_path), "add", config])
+
+    async def run_interactive(self, hook: str) -> None:
+        success: bool = False
+        while not success:
+            fail = run(
+                [str(self.config.pre_commit_path), "run", hook.lower(), "--all-files"]
+            )
+            if fail.returncode > 0:
+                retry = await ainput(f"\n\n{hook.title()} failed. Retry? (y/N): ")
+                await aprint()
+                if retry.strip().lower() == "y":
+                    continue
+                sys.exit()
+            success = True
+
+    async def update_pkg_configs(self) -> None:
+        await self.copy_configs()
+        installed_pkgs = run(
+            [str(self.config.pdm_path), "list", "--freeze"],
+            capture_output=True,
+            text=True,
+        ).stdout.splitlines()
+        if not len([pkg for pkg in installed_pkgs if "pre-commit" in pkg]):
+            print('Installing "pre-commit"...')
+            run([str(self.config.pdm_path), "self", "add", "keyring"])
+            run([str(self.config.pdm_path), "config", "python.use_venv", "false"])
+            run([str(self.config.git_path), "init"])
+            run([str(self.config.git_path), "branch", "-m", "main"])
+            run([str(self.config.git_path), "add", "pyproject.toml"])
+            run([str(self.config.git_path), "add", "pdm.lock"])
+            run([str(self.config.pre_commit_path), "install"])
+            run(
+                [
+                    str(self.config.git_path),
+                    "config",
+                    "advice.addIgnoredFile",
+                    "false",
+                ]
+            )
+        await self.update_pyproject_configs()
+
+    async def process(self, options: t.Any) -> None:
+        await self.settings_path.touch(exist_ok=True)
+        try:
+            self.config = Config(**await load.yaml(self.settings_path))
+        except TypeError:
+            self.config = Config()
+            await dump.yaml(self.config.model_dump(), self.settings_path)
+            raise SystemExit("\nPlease configure '.crackerjack.yaml' and try again\n")
+        imp_dir = self.pkg_path / "__pypackages__" / self.config.python_version / "lib"
+        sys.path.append(str(imp_dir))
+        self.pkg_name = underscore(self.pkg_path.stem.lower())
+        self.pkg_dir = self.pkg_path / self.pkg_name
+        await self.pkg_dir.mkdir(exist_ok=True)
+        await aprint("\nCrackerjacking...\n")
+        if not options.do_not_update_configs:
+            await self.update_pkg_configs()
+            run([str(self.config.pdm_path), "install"])
+        if self.pkg_path.stem == "crackerjack" and options.update_precommit:
+            run([str(self.config.pre_commit_path), "autoupdate"])
+        if options.interactive:
+            for hook in ("refurb", "bandit", "pyright"):
+                await self.run_interactive(hook)
+        check_all = run([str(self.config.pre_commit_path), "run", "--all-files"])
+        if check_all.returncode > 0:
+            check_all = run([str(self.config.pre_commit_path), "run", "--all-files"])
+            if check_all.returncode > 0:
+                await aprint("\n\nPre-commit failed. Please fix errors.\n")
+                raise SystemExit()
+        for option in (options.publish, options.bump):
+            if option:
+                run([str(self.config.pdm_path), "bump", option])
+                break
+        if options.publish:
+            run([str(self.config.pdm_path), "publish"])
+        if options.commit:
+            commit_msg = await ainput("\nCommit message: ")
+            run(
+                [
+                    str(self.config.git_path),
+                    "commit",
+                    "-m",
+                    str(commit_msg),
+                    "--no-verify",
+                    "--",
+                    ".",
+                ]
+            )
+            run([str(self.config.git_path), "push", "origin", "main"])
+        await aprint("\nCrackerjack complete!\n")
+
+    async def run(self, options: t.Any) -> None:
+        process = asyncio.create_task(self.process(options))
+        await process
+
+
+crackerjack_it = Crackerjack().run