From 819a14b07a9687f70e2b3ab904b144b657c0e097 Mon Sep 17 00:00:00 2001 From: Michael Tinsley Date: Wed, 9 Mar 2022 09:56:05 +0000 Subject: [PATCH 1/3] Readd `__main__.py` --- prospector/__main__.py | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 prospector/__main__.py diff --git a/prospector/__main__.py b/prospector/__main__.py new file mode 100644 index 00000000..8ef4ae9e --- /dev/null +++ b/prospector/__main__.py @@ -0,0 +1,6 @@ +import sys + +from prospector.run import main + +if __name__ == "__main__": + sys.exit(main()) From ffed56fde68ed9de3ae2bde27d7eb8ee82e6444d Mon Sep 17 00:00:00 2001 From: Michael Tinsley Date: Wed, 9 Mar 2022 10:20:39 +0000 Subject: [PATCH 2/3] Update documentation --- docs/usage.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/usage.rst b/docs/usage.rst index 6e98a0cf..40c5dc5d 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -20,6 +20,9 @@ And you can specify a list of python modules:: See below for :ref:`a complete list of options and flags`. You can also run ``prospector --help`` for a full list of options and their effects. +Alternatively, prospector can be executed as a module:: + + python3 -m prospector Output Format ''''''''''''' From 1cd0eb77a9e194472566bb2f81ad9981d8bcf431 Mon Sep 17 00:00:00 2001 From: Michael Tinsley Date: Wed, 9 Mar 2022 10:25:54 +0000 Subject: [PATCH 3/3] Add `CONTRIBUTORS.rst` entry --- CONTRIBUTING.rst | 2 +- CONTRIBUTORS.rst | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 7e7d38d5..174ae568 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -7,7 +7,7 @@ All contributions are very welcome! You can contribute in many ways: * Report bugs on the GitHub `issue tracker`_. -* Submit pull requests on the GitHub `repository`_. Ideally make a pull request to the *develop* branch, as I prefer to keep the master branch the same as the most recent release on PyPI. If you do this, be sure to add yourself to the CONTRIBUTORS.md file too! +* Submit pull requests on the GitHub `repository`_. Ideally make a pull request to the *develop* branch, as I prefer to keep the master branch the same as the most recent release on PyPI. If you do this, be sure to add yourself to the CONTRIBUTORS.rst file too! .. _python code quality: https://mail.python.org/mailman/listinfo/code-quality .. _issue tracker: https://github.com/PyCQA/prospector/issues diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index f541cd8c..2c263326 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -23,6 +23,7 @@ Contributors * Kristian Glass (`@doismellburning `_) * Luke Hinds (`@lukehinds `_) * Matt Seymour (`@mattseymour `_) +* Michael Tinsley (`@michaeltinsley `_) * Phil Frost (`@bitglue `_) * Phil Jones (`@pgjones `_) * Pierre Sassoulas (`@Pierre-Sassoulas `_)