git-goose 0.0.1__tar.gz

git_goose-0.0.1/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Anton Agestam
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

git_goose-0.0.1/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.1
+Name: git-goose
+Version: 0.0.1
+Summary: A picky and eager Git hook runner.
+Author-email: Anton Agestam <git@antonagestam.se>
+License: BSD 3-Clause
+Project-URL: Source Repository, https://github.com/antonagestam/goose
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: <3.13,>3.12
+Description-Content-Type: text/markdown; charset=UTF-8
+License-File: LICENSE
+Requires-Dist: pydantic
+Requires-Dist: PyYAML
+Requires-Dist: nodeenv
+Requires-Dist: identify
+Requires-Dist: typer
+Requires-Dist: rich
+Requires-Dist: shellingham
+
+<!-- prettier-ignore-start -->
+<!-- https://github.com/prettier/prettier/issues/15479 -->
+
+> [!NOTE]
+> This project is in its infancy. Please try it out and report and help fix any issues or missing features, but expect a somewhat broken experience.
+>
+> Breaking CLI changes is to be expected without notice between arbitrary versions until version 1.0 is released.
+
+<!-- prettier-ignore-end -->
+
+<h1 align=center>goose<br>🦆🧪💻</h1>
+
+<p align=center>A <i>picky</i> and <i>eager</i> <a href=https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks>Git hook</a> runner.</p>
+
+- Reproducible builds.
+- Dynamic parallelism.
+- Small file-system footprint.
+
+### Features
+
+- Smart parallelism schedules hooks across CPUs while avoiding concurrent writes.
+- Deterministic environments by using ecosystem-specific lock files.
+- Environments are shared across hooks.
+- Self-contained definitions means there's no need to push tool-specific configuration
+  upstream, or to maintain brittle mirroring schemes.
+
+### Parallelism
+
+Goose takes care to keep your CPUs as busy as possible, optimizing to have the full
+suite of hooks finish as soon as possible. It does this by distributing units of work to
+all available processing cores.
+
+Parameterized hooks, or hooks that take files as command line arguments, are divided to
+one unit of work per available core. Whenever a core becomes available for more work, a
+new unit is chosen for execution.
+
+The scheduler takes care to never run more than one mutating hook on the same file. It
+does this by taking into account hooks marked as `read_only` and by comparing sets of
+files a unit of work is assigned to. Two incompatible hooks can be simultaneously
+working on two separate parts of the code-base.
+
+### Deterministic environments
+
+Goose uses lock files to facilitate deterministic results across developer environments
+and CI. You specify dependencies in `goose.yaml`, and invoking `goose run` will produce
+the appropriate lock files under a `.goose/` directory. The `.goose/` directory is meant
+to be checked into git, so that future invocations of `goose run` can use the lock files
+it contains to produce identical environments for hooks to run in.
+
+## Usage
+
+Create a `goose.yaml` file in the repository root.
+
+```yaml
+environments:
+  - id: python
+    ecosystem:
+      language: python
+      version: "3.12"
+    dependencies:
+      - ruff
+
+hooks:
+  - id: ruff
+    environment: python
+    command: ruff
+    args: [check, --force-exclude, --fix]
+    types: [python]
+
+  - id: ruff-format
+    environment: python
+    command: ruff
+    args: [format, --force-exclude]
+    types: [python]
+```
+
+Bootstrap environments, generate lock files, and install dependencies.
+
+```sh
+$ python -m goose upgrade
+```
+
+Run all hooks over all files.
+
+```sh
+$ python -m goose run --select=all
+```
+
+Commit configuration and lock files.
+
+```sh
+$ git add goose.yaml .goose
+$ git commit -m 'Add goose configuration'
+```
+
+### Upgrading hook versions
+
+As pinning of hook versions is handled with lock files, there's no need to change
+configuration to upgrade hook dependency versions, instead you just run the upgrade
+command.
+
+```sh
+$ python -m goose upgrade
+$ git add .goose
+$ git commit -m 'Bump goose dependencies'
+```
+
+### Example node hook
+
+Goose currently supports Python and Node environments, here's an example using
+[Prettier] to format Markdown files.
+
+[Prettier]: https://prettier.io/
+
+```yaml
+environments:
+  - id: node
+    ecosystem:
+      language: node
+      version: "21.7.1"
+    dependencies:
+      - prettier
+
+hooks:
+  - id: prettier
+    environment: node
+    command: prettier
+    types: [markdown]
+    args:
+      - --write
+      - --ignore-unknown
+      - --parser=markdown
+      - --print-width=88
+      - --prose-wrap=always
+```
+
+### Read-only hooks
+
+You will likely want to use a mix of pure linters, as well as formatters and
+auto-fixers. Tools that don't mutate files can be more heavily parallelized by Goose,
+because they can inspect overlapping sets of files simultaneously as other tools. To
+enable this you set `read_only: true` in hook configuration.
+
+```yaml
+environments:
+  - id: python
+    ecosystem:
+      language: python
+      version: "3.12"
+    dependencies:
+      - pre-commit-hooks
+
+hooks:
+  - id: check-case-conflict
+    environment: python
+    command: check-case-conflict
+    read_only: true
+
+  - id: check-merge-conflict
+    environment: python
+    command: check-merge-conflict
+    read_only: true
+    types: [text]
+
+  - id: python-debug-statements
+    environment: python
+    command: debug-statement-hook
+    read_only: true
+    types: [python]
+
+  - id: detect-private-key
+    environment: python
+    command: detect-private-key
+    read_only: true
+    types: [text]
+
+  - id: end-of-file-fixer
+    environment: python
+    command: end-of-file-fixer
+    types: [text]
+
+  - id: trailing-whitespace-fixer
+    environment: python
+    command: trailing-whitespace-fixer
+    types: [text]
+```
+
+Hooks that do not specify `read_only: true` will never run simultaneously as other tools
+over the same file.
+
+### Non-parameterized hooks
+
+Some tools don't support passing files, or just work better if given the responsibility
+to parallelize work itself. One such tool is mypy. You can instruct goose to not pass
+filenames to a hook (and as a consequence, also not spawn multiple parallel jobs for
+this hook).
+
+```yaml
+environments:
+  - id: mypy
+    ecosystem:
+      language: python
+      version: "3.12"
+    dependencies:
+      - mypy
+
+hooks:
+  - id: mypy
+    environment: mypy
+    command: mypy
+    read_only: true
+    parameterize: false
+```

git_goose-0.0.1/README.md

@@ -0,0 +1,213 @@
+<!-- prettier-ignore-start -->
+<!-- https://github.com/prettier/prettier/issues/15479 -->
+
+> [!NOTE]
+> This project is in its infancy. Please try it out and report and help fix any issues or missing features, but expect a somewhat broken experience.
+>
+> Breaking CLI changes is to be expected without notice between arbitrary versions until version 1.0 is released.
+
+<!-- prettier-ignore-end -->
+
+<h1 align=center>goose<br>🦆🧪💻</h1>
+
+<p align=center>A <i>picky</i> and <i>eager</i> <a href=https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks>Git hook</a> runner.</p>
+
+- Reproducible builds.
+- Dynamic parallelism.
+- Small file-system footprint.
+
+### Features
+
+- Smart parallelism schedules hooks across CPUs while avoiding concurrent writes.
+- Deterministic environments by using ecosystem-specific lock files.
+- Environments are shared across hooks.
+- Self-contained definitions means there's no need to push tool-specific configuration
+  upstream, or to maintain brittle mirroring schemes.
+
+### Parallelism
+
+Goose takes care to keep your CPUs as busy as possible, optimizing to have the full
+suite of hooks finish as soon as possible. It does this by distributing units of work to
+all available processing cores.
+
+Parameterized hooks, or hooks that take files as command line arguments, are divided to
+one unit of work per available core. Whenever a core becomes available for more work, a
+new unit is chosen for execution.
+
+The scheduler takes care to never run more than one mutating hook on the same file. It
+does this by taking into account hooks marked as `read_only` and by comparing sets of
+files a unit of work is assigned to. Two incompatible hooks can be simultaneously
+working on two separate parts of the code-base.
+
+### Deterministic environments
+
+Goose uses lock files to facilitate deterministic results across developer environments
+and CI. You specify dependencies in `goose.yaml`, and invoking `goose run` will produce
+the appropriate lock files under a `.goose/` directory. The `.goose/` directory is meant
+to be checked into git, so that future invocations of `goose run` can use the lock files
+it contains to produce identical environments for hooks to run in.
+
+## Usage
+
+Create a `goose.yaml` file in the repository root.
+
+```yaml
+environments:
+  - id: python
+    ecosystem:
+      language: python
+      version: "3.12"
+    dependencies:
+      - ruff
+
+hooks:
+  - id: ruff
+    environment: python
+    command: ruff
+    args: [check, --force-exclude, --fix]
+    types: [python]
+
+  - id: ruff-format
+    environment: python
+    command: ruff
+    args: [format, --force-exclude]
+    types: [python]
+```
+
+Bootstrap environments, generate lock files, and install dependencies.
+
+```sh
+$ python -m goose upgrade
+```
+
+Run all hooks over all files.
+
+```sh
+$ python -m goose run --select=all
+```
+
+Commit configuration and lock files.
+
+```sh
+$ git add goose.yaml .goose
+$ git commit -m 'Add goose configuration'
+```
+
+### Upgrading hook versions
+
+As pinning of hook versions is handled with lock files, there's no need to change
+configuration to upgrade hook dependency versions, instead you just run the upgrade
+command.
+
+```sh
+$ python -m goose upgrade
+$ git add .goose
+$ git commit -m 'Bump goose dependencies'
+```
+
+### Example node hook
+
+Goose currently supports Python and Node environments, here's an example using
+[Prettier] to format Markdown files.
+
+[Prettier]: https://prettier.io/
+
+```yaml
+environments:
+  - id: node
+    ecosystem:
+      language: node
+      version: "21.7.1"
+    dependencies:
+      - prettier
+
+hooks:
+  - id: prettier
+    environment: node
+    command: prettier
+    types: [markdown]
+    args:
+      - --write
+      - --ignore-unknown
+      - --parser=markdown
+      - --print-width=88
+      - --prose-wrap=always
+```
+
+### Read-only hooks
+
+You will likely want to use a mix of pure linters, as well as formatters and
+auto-fixers. Tools that don't mutate files can be more heavily parallelized by Goose,
+because they can inspect overlapping sets of files simultaneously as other tools. To
+enable this you set `read_only: true` in hook configuration.
+
+```yaml
+environments:
+  - id: python
+    ecosystem:
+      language: python
+      version: "3.12"
+    dependencies:
+      - pre-commit-hooks
+
+hooks:
+  - id: check-case-conflict
+    environment: python
+    command: check-case-conflict
+    read_only: true
+
+  - id: check-merge-conflict
+    environment: python
+    command: check-merge-conflict
+    read_only: true
+    types: [text]
+
+  - id: python-debug-statements
+    environment: python
+    command: debug-statement-hook
+    read_only: true
+    types: [python]
+
+  - id: detect-private-key
+    environment: python
+    command: detect-private-key
+    read_only: true
+    types: [text]
+
+  - id: end-of-file-fixer
+    environment: python
+    command: end-of-file-fixer
+    types: [text]
+
+  - id: trailing-whitespace-fixer
+    environment: python
+    command: trailing-whitespace-fixer
+    types: [text]
+```
+
+Hooks that do not specify `read_only: true` will never run simultaneously as other tools
+over the same file.
+
+### Non-parameterized hooks
+
+Some tools don't support passing files, or just work better if given the responsibility
+to parallelize work itself. One such tool is mypy. You can instruct goose to not pass
+filenames to a hook (and as a consequence, also not spawn multiple parallel jobs for
+this hook).
+
+```yaml
+environments:
+  - id: mypy
+    ecosystem:
+      language: python
+      version: "3.12"
+    dependencies:
+      - mypy
+
+hooks:
+  - id: mypy
+    environment: mypy
+    command: mypy
+    read_only: true
+    parameterize: false
+```

git_goose-0.0.1/pyproject.toml

@@ -0,0 +1,74 @@
+[project]
+name = "git-goose"
+authors = [
+  { name="Anton Agestam", email="git@antonagestam.se" },
+]
+description = "A picky and eager Git hook runner."
+license = {text = "BSD 3-Clause"}
+version = "0.0.1"
+requires-python = ">3.12,<3.13"
+classifiers = [
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.12",
+  "Typing :: Typed",
+]
+dynamic = ["readme"]
+dependencies = [
+  "pydantic",
+  "PyYAML",
+  "nodeenv",
+  "identify",
+  "typer",
+  # https://typer.tiangolo.com/#optional-dependencies
+  "rich",
+  # https://typer.tiangolo.com/#optional-dependencies
+  "shellingham",
+]
+
+[project.urls]
+"Source Repository" = "https://github.com/antonagestam/goose"
+
+[build-system]
+requires = ["setuptools==70.3.0", "wheel==0.43.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+readme = {file = "README.md", content-type = "text/markdown; charset=UTF-8"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
+
+[tool.pip-tools]
+generate-hashes = true
+strip-extras = true
+upgrade = true
+
+[tool.mypy]
+python_version = 3.12
+show_error_codes = true
+pretty = true
+files = ["src", "tests"]
+plugins = ["pydantic.mypy"]
+
+ignore_missing_imports = false
+no_implicit_reexport = true
+no_implicit_optional = true
+strict_equality = true
+strict_optional = true
+check_untyped_defs = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_subclassing_any = true
+
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+warn_unreachable = true

git_goose-0.0.1/setup.cfg

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