Make flake8 dependency optional (#82)

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## [0.3.2] - 2023-09-04
+
+- Changed
+
+  - Make `flake8` an optional dependency
+
+- Full diff
+  - https://github.com/jsh9/pydoclint/compare/0.3.1...0.3.2
+
 ## [0.3.1] - 2023-08-28
 
 - Added

README.md

@@ -50,10 +50,19 @@ serves complementary purposes. It is recommended that you use both together.
 
 ## 1. Installation
 
+To install only the native _pydoclint_ tooling, run this command:
+
 ```
 pip install pydoclint
 ```
 
+To use _pydoclint_ as a _flake8_ plugin, please run this command, which will
+also install _flake8_ to the current Python environment:
+
+```
+pip install pydoclint[flake8]
+```
+
 Note that _pydoclint_ currently only supports Python 3.8 and above. (Python 3.7
 support may be added if there are interests and requests.)
 

docs/index.md

@@ -50,10 +50,19 @@ serves complementary purposes. It is recommended that you use both together.
 
 ## 1. Installation
 
+To install only the native _pydoclint_ tooling, run this command:
+
 ```
 pip install pydoclint
 ```
 
+To use _pydoclint_ as a _flake8_ plugin, please run this command, which will
+also install _flake8_ to the current Python environment:
+
+```
+pip install pydoclint[flake8]
+```
+
 Note that _pydoclint_ currently only supports Python 3.8 and above. (Python 3.7
 support may be added if there are interests and requests.)
 

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pydoclint
-version = 0.3.1
+version = 0.3.2
 description = A Python docstring linter that checks arguments, returns, yields, and raises sections
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -15,12 +15,15 @@ classifiers =
 [options]
 packages = find:
 install_requires =
-    flake8>=4
     click>=8.0.0
     docstring_parser_fork>=0.0.4
     tomli>=2.0.1; python_version<'3.11'
 python_requires = >=3.8
 
+[options.extras_require]
+flake8 =
+    flake8>=4
+
 [options.packages.find]
 exclude =
     tests*