pyproject-pre-commit 0.1.10__tar.gz → 0.2.0__tar.gz

{pyproject_pre_commit-0.1.10 → pyproject_pre_commit-0.2.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: pyproject-pre-commit
-Version: 0.1.10
+Version: 0.2.0
 Summary: pre-commit hooks for python projects using pyproject.toml.
 Home-page: https://github.com/rcmdnk/pyproject-pre-commit
 License: Apache-2.0
 Keywords: pre-commit,pyproject.toml,poetry
 Author: rcmdnk
 Author-email: rcmdnk@gmail.com
-Requires-Python: >=3.8.1,<4.0.0
+Requires-Python: >=3.9.0,<4.0.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -44,7 +44,7 @@ Requires-Dist: mdformat-footnote (>=0.1.1,<0.2.0)
 Requires-Dist: mdformat-frontmatter (>=2.0.1,<3.0.0)
 Requires-Dist: mdformat-gfm (>=0.3.5,<0.4.0)
 Requires-Dist: mypy (>=1.5.1,<2.0.0)
-Requires-Dist: numpydoc (>=1.6.0,<2.0.0)
+Requires-Dist: numpydoc (>=1.8.0,<2.0.0)
 Requires-Dist: pep8-naming (>=0.14.0,<0.15.0)
 Requires-Dist: pre-commit (>=3.3.3,<4.0.0)
 Requires-Dist: pycodestyle (>=2.11.0,<3.0.0)
@@ -57,16 +57,21 @@ Description-Content-Type: text/markdown
 [![test](https://github.com/rcmdnk/pyproject-pre-commit/actions/workflows/test.yml/badge.svg)](https://github.com/rcmdnk/pyproject-pre-commit/actions/workflows/test.yml)
 [![test coverage](https://img.shields.io/badge/coverage-check%20here-blue.svg)](https://github.com/rcmdnk/pyproject-pre-commit/tree/coverage)
 
-pre-commit hooks for python projects using pyproject.toml.
+[pre-commit](https://pre-commit.com/) hooks for python projects.
 
 **.pre-commit-hooks.yaml** provides pre-defined ids which you just need to add these ids to your **.pre-commit-config.yaml**.
 
+By installing **pyproject-pre-commit** package,
+all necessary tools are installed as dependencies.
+
 ## Requirement
 
-- Python 3.11, 3.10, 3.9, 3.8
+- Python >= 3.8.1
 - Poetry (For development)
 
-## Installation
+## Usage
+
+### Install pyproject-pre-commit
 
 If your project uses poetry, do:
 
@@ -74,17 +79,92 @@ If your project uses poetry, do:
 $ poetry add --group dev pyproject-pre-commit
 ```
 
-Otherwise, install by pip:
+Otherwise, install the package in your working environment.
+
+If you use pip, do:
 
 ```
 $ pip install pyproject-pre-commit
 ```
 
-## The repository features
+This will install tools for pre-commit hooks in your working environment,
+so that you can use these tools, such as black, directly.
 
-If you install this package, several linters/formatters will be installed, too.
+### Prepare .pre-commit-config.yaml
 
-This repository has following hooks for [pre-commit](https://pre-commit.com/):
+Add **https://github.com/rcmdnk/pyproject-pre-commit** to your **.pre-commit-config.yaml**, like:
+
+```yaml
+repos:
+- repo: https://github.com/rcmdnk/pyproject-pre-commit
+  rev: v0.1.1
+  hooks:
+  - id: black-diff
+  - id: black
+  - id: blacken-docs
+  - id: autoflake-diff
+  - id: autoflake
+  - id: autopep8-diff
+  - id: autopep8
+  - id: isort-diff
+  - id: isort
+  - id: flake8
+  - id: bandit
+  - id: mypy
+  - id: shellcheck
+  - id: mdformat-check
+  - id: mdformat
+```
+
+By using **pyproject-pre-commit**, you can simplify your **.pre-commit-config.yaml**
+that you need only repo of **https://github.com/rcmdnk/pyproject-pre-commit**.
+
+These hooks uses local installation of tools, so pre-commit will use
+tools installed in your working environment.
+
+This can be made by `ppc` command:
+
+```
+$ ppc --pre-commit > .pre-commit-config.yaml
+```
+
+> \[!NOTE\]
+> If you are using poetry, run `poetry run ppc ... ` or run after `poetry shell`.
+
+If you already have it, add hooks w/o `repos:` by
+
+```
+$ ppc --pre-commit |grep -v "^repos:" >> .pre-commit-config.yaml
+```
+
+You may want to modify after adding these configurations.
+
+### Run pre-commit
+
+`pre-commit` command is installed as dependencies of **pyproject-pre-commit** package.
+
+After installing **pyproject-pre-commit** package, you can run `pre-commit` command.
+
+First, install pre-commit hooks by:
+
+```
+$ pre-commit install
+```
+
+then you can run pre-commit by:
+
+```
+$ pre-commit run --all-files
+```
+
+> \[!NOTE\]
+> If you are using poetry, run `poetry run pre-commit ... ` or run after `poetry shell`.
+
+## Available ids
+
+You can find ids in **.pre-commit-hooks.yaml**.
+
+There are ids for following tools:
 
 - For Python
   - black-diff: Just show Black result.
@@ -124,60 +204,23 @@ This repository has following hooks for [pre-commit](https://pre-commit.com/):
       - [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter)
       - [mdformat-footnote](https://github.com/executablebooks/mdformat-footnote)
 
-All tools are installed as dependencies of this package.
+All tools are installed as dependencies of **pyproject-pre-commit** package.
 
 shellcheck and mdformat are given in addition to python tools
 as they can be managed by pip and most projects have README.md
 and some have shell scripts.
 
-For tools which can format files, there are additional ids ids with `-diff` or `--check`
-which just show the results and not modify files.
-You can see the difference after formatting if you place these ids before ids w/o `--diff` or `--check`.
-
-You can set options in pyproject.toml for all tools above:
-
-- flake8: flake8-pyproject allows to read options from pyproject.toml
-- bandit: There is a plugin for the flake8, but plugin version does not read options from pyproject.toml even with pyproject.toml. Therefore, use bandit directly and give `-c pyproject.toml` option in the hooks.
-
-## .pre-commit-config.yaml
-
-Prepare **.pre-commit-config.yaml** like:
-
-```yaml
-repos:
-- repo: https://github.com/rcmdnk/pyproject-pre-commit
-  rev: v0.1.1
-  hooks:
-  - id: black-diff
-  - id: black
-  - id: blacken-docs
-  - id: autoflake-diff
-  - id: autoflake
-  - id: autopep8-diff
-  - id: autopep8
-  - id: isort-diff
-  - id: isort
-  - id: flake8
-  - id: bandit
-  - id: mypy
-  - id: shellcheck
-  - id: mdformat-check
-  - id: mdformat
-```
-
-This can be made by `ppc` command:
+For tools which can format files, there are additional ids with `-diff` or `--check`
+which show the results before modifying files.
+You can see the differences after formatting if you place these ids before ids w/o `--diff` or `--check`.
 
-```
-$ ppc --pre-commit > .pre-commit-config.yaml
-```
+## Options for tools
 
-If you already have it, add hooks w/o `repos:` by
+You can set options in pyproject.toml for all tools above.
 
-```
-$ ppc --pre-commit |grep -v "^repos:" >> .pre-commit-config.yaml
-```
+For flake8, flake8-pyproject allows to read options from pyproject.toml
 
-You may want to modify after adding these configurations.
+About bandit, there is a plugin for the flake8, but plugin version does not read options from pyproject.toml even with pyproject.toml. Therefore, use bandit directly and give `-c pyproject.toml` option in the hooks.
 
 ## pyproject.toml
 

{pyproject_pre_commit-0.1.10 → pyproject_pre_commit-0.2.0}/README.md

@@ -3,16 +3,21 @@
 [![test](https://github.com/rcmdnk/pyproject-pre-commit/actions/workflows/test.yml/badge.svg)](https://github.com/rcmdnk/pyproject-pre-commit/actions/workflows/test.yml)
 [![test coverage](https://img.shields.io/badge/coverage-check%20here-blue.svg)](https://github.com/rcmdnk/pyproject-pre-commit/tree/coverage)
 
-pre-commit hooks for python projects using pyproject.toml.
+[pre-commit](https://pre-commit.com/) hooks for python projects.
 
 **.pre-commit-hooks.yaml** provides pre-defined ids which you just need to add these ids to your **.pre-commit-config.yaml**.
 
+By installing **pyproject-pre-commit** package,
+all necessary tools are installed as dependencies.
+
 ## Requirement
 
-- Python 3.11, 3.10, 3.9, 3.8
+- Python >= 3.8.1
 - Poetry (For development)
 
-## Installation
+## Usage
+
+### Install pyproject-pre-commit
 
 If your project uses poetry, do:
 
@@ -20,17 +25,92 @@ If your project uses poetry, do:
 $ poetry add --group dev pyproject-pre-commit
 ```
 
-Otherwise, install by pip:
+Otherwise, install the package in your working environment.
+
+If you use pip, do:
 
 ```
 $ pip install pyproject-pre-commit
 ```
 
-## The repository features
+This will install tools for pre-commit hooks in your working environment,
+so that you can use these tools, such as black, directly.
 
-If you install this package, several linters/formatters will be installed, too.
+### Prepare .pre-commit-config.yaml
 
-This repository has following hooks for [pre-commit](https://pre-commit.com/):
+Add **https://github.com/rcmdnk/pyproject-pre-commit** to your **.pre-commit-config.yaml**, like:
+
+```yaml
+repos:
+- repo: https://github.com/rcmdnk/pyproject-pre-commit
+  rev: v0.1.1
+  hooks:
+  - id: black-diff
+  - id: black
+  - id: blacken-docs
+  - id: autoflake-diff
+  - id: autoflake
+  - id: autopep8-diff
+  - id: autopep8
+  - id: isort-diff
+  - id: isort
+  - id: flake8
+  - id: bandit
+  - id: mypy
+  - id: shellcheck
+  - id: mdformat-check
+  - id: mdformat
+```
+
+By using **pyproject-pre-commit**, you can simplify your **.pre-commit-config.yaml**
+that you need only repo of **https://github.com/rcmdnk/pyproject-pre-commit**.
+
+These hooks uses local installation of tools, so pre-commit will use
+tools installed in your working environment.
+
+This can be made by `ppc` command:
+
+```
+$ ppc --pre-commit > .pre-commit-config.yaml
+```
+
+> \[!NOTE\]
+> If you are using poetry, run `poetry run ppc ... ` or run after `poetry shell`.
+
+If you already have it, add hooks w/o `repos:` by
+
+```
+$ ppc --pre-commit |grep -v "^repos:" >> .pre-commit-config.yaml
+```
+
+You may want to modify after adding these configurations.
+
+### Run pre-commit
+
+`pre-commit` command is installed as dependencies of **pyproject-pre-commit** package.
+
+After installing **pyproject-pre-commit** package, you can run `pre-commit` command.
+
+First, install pre-commit hooks by:
+
+```
+$ pre-commit install
+```
+
+then you can run pre-commit by:
+
+```
+$ pre-commit run --all-files
+```
+
+> \[!NOTE\]
+> If you are using poetry, run `poetry run pre-commit ... ` or run after `poetry shell`.
+
+## Available ids
+
+You can find ids in **.pre-commit-hooks.yaml**.
+
+There are ids for following tools:
 
 - For Python
   - black-diff: Just show Black result.
@@ -70,60 +150,23 @@ This repository has following hooks for [pre-commit](https://pre-commit.com/):
       - [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter)
       - [mdformat-footnote](https://github.com/executablebooks/mdformat-footnote)
 
-All tools are installed as dependencies of this package.
+All tools are installed as dependencies of **pyproject-pre-commit** package.
 
 shellcheck and mdformat are given in addition to python tools
 as they can be managed by pip and most projects have README.md
 and some have shell scripts.
 
-For tools which can format files, there are additional ids ids with `-diff` or `--check`
-which just show the results and not modify files.
-You can see the difference after formatting if you place these ids before ids w/o `--diff` or `--check`.
-
-You can set options in pyproject.toml for all tools above:
-
-- flake8: flake8-pyproject allows to read options from pyproject.toml
-- bandit: There is a plugin for the flake8, but plugin version does not read options from pyproject.toml even with pyproject.toml. Therefore, use bandit directly and give `-c pyproject.toml` option in the hooks.
-
-## .pre-commit-config.yaml
-
-Prepare **.pre-commit-config.yaml** like:
-
-```yaml
-repos:
-- repo: https://github.com/rcmdnk/pyproject-pre-commit
-  rev: v0.1.1
-  hooks:
-  - id: black-diff
-  - id: black
-  - id: blacken-docs
-  - id: autoflake-diff
-  - id: autoflake
-  - id: autopep8-diff
-  - id: autopep8
-  - id: isort-diff
-  - id: isort
-  - id: flake8
-  - id: bandit
-  - id: mypy
-  - id: shellcheck
-  - id: mdformat-check
-  - id: mdformat
-```
-
-This can be made by `ppc` command:
+For tools which can format files, there are additional ids with `-diff` or `--check`
+which show the results before modifying files.
+You can see the differences after formatting if you place these ids before ids w/o `--diff` or `--check`.
 
-```
-$ ppc --pre-commit > .pre-commit-config.yaml
-```
+## Options for tools
 
-If you already have it, add hooks w/o `repos:` by
+You can set options in pyproject.toml for all tools above.
 
-```
-$ ppc --pre-commit |grep -v "^repos:" >> .pre-commit-config.yaml
-```
+For flake8, flake8-pyproject allows to read options from pyproject.toml
 
-You may want to modify after adding these configurations.
+About bandit, there is a plugin for the flake8, but plugin version does not read options from pyproject.toml even with pyproject.toml. Therefore, use bandit directly and give `-c pyproject.toml` option in the hooks.
 
 ## pyproject.toml
 

{pyproject_pre_commit-0.1.10 → pyproject_pre_commit-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyproject-pre-commit"
-version = "0.1.10"
+version = "0.2.0"
 description = "pre-commit hooks for python projects using pyproject.toml."
 authors = ["rcmdnk <rcmdnk@gmail.com>"]
 repository = "https://github.com/rcmdnk/pyproject-pre-commit"
@@ -19,7 +19,7 @@ classifiers = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.8.1"
+python = "^3.9.0"
 pre-commit = "^3.3.3"
 black = "^24.3.0"
 blacken-docs = "^1.16.0"
@@ -42,7 +42,7 @@ autopep8 = "^2.0.4"
 isort = "^5.12.0"
 mypy = "^1.5.1"
 bandit = {extras = ["toml"], version = "^1.7.5"}
-numpydoc = "^1.6.0"
+numpydoc = "^1.8.0"
 shellcheck-py = "^0.9.0.5"
 mdformat = "^0.7.17"
 mdformat-gfm = "^0.3.5"
@@ -100,6 +100,8 @@ strict = true
 warn_return_any = false
 ignore_missing_imports = true
 scripts_are_modules = true
+install_types = true
+non_interactive = true
 
 [tool.numpydoc_validation]
 checks = [