feat: set CLI options with environment variables

docs/cli.rst

@@ -5,10 +5,6 @@
 Command-line interface
 ======================
 
-.. note::
-
-    The CLI is experimental, still under active development.
-
 Nitpick_ has a CLI command to fix files automatically.
 
 1. It doesn't work for all the plugins yet. Currently, it works for:
@@ -21,6 +17,7 @@ Nitpick_ has a CLI command to fix files automatically.
 4. Run ``nitpick fix`` to modify files directly, or ``nitpick check`` to only display the violations.
 5. The flake8_ plugin only checks the files and doesn't make changes. This is the default for now; once the CLI becomes more stable, the "fix mode" will become the default.
 6. The output format aims to follow `pycodestyle (pep8) default output format <https://github.com/PyCQA/pycodestyle/blob/master/pycodestyle.py#L108>`_.
+7. You can set options through environment variables using the format ``NITPICK_command_option``. E.e: ``NITPICK_CHECK_VERBOSE=3 nitpick check``. For more details on how this works, see the `Click documentation about CLI options <https://click.palletsprojects.com/en/8.1.x/options/#values-from-environment-variables>`_.
 
 If you use Git, you can review the files before committing.
 

pyproject.toml

@@ -111,7 +111,7 @@ toml = "nitpick.plugins.toml"
 yaml = "nitpick.plugins.yaml"
 
 [tool.poetry.scripts]
-nitpick = "nitpick.cli:nitpick_cli"
+nitpick = "nitpick.__main__:main"
 
 [tool.poetry.urls]
 "Changelog" = "https://github.com/andreoliwa/nitpick/blob/develop/CHANGELOG.md"

src/nitpick/__main__.py

@@ -7,6 +7,13 @@
 """
 # pragma: no cover
 from nitpick.cli import nitpick_cli
+from nitpick.constants import PROJECT_NAME
+
+
+def main() -> None:
+    """Entry point for the application script."""
+    nitpick_cli(auto_envvar_prefix=PROJECT_NAME)
+
 
 if __name__ == "__main__":
-    nitpick_cli()
+    main()