From 61208e4961bb8d088c272a18577f5a12f23a8bcf Mon Sep 17 00:00:00 2001 From: Evan Kepner Date: Sat, 26 Oct 2019 12:56:48 -0400 Subject: [PATCH] move to 1.1.0 --- CHANGELOG.rst | 6 ++++++ docs/commandline.rst | 32 ++++++++++++++++++++++++++++++++ docs/conf.py | 10 +++++++++- mutatest/__init__.py | 2 +- 4 files changed, 48 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a564021..da8b791 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,12 @@ Changelog Beta Releases ------------- +1.1.0 +~~~~~ + + - Add support for a ``mutatest.ini`` configuration file for command line arguments. + + 1.0.1 ~~~~~ diff --git a/docs/commandline.rst b/docs/commandline.rst index 17c78a3..e6771cf 100644 --- a/docs/commandline.rst +++ b/docs/commandline.rst @@ -333,6 +333,38 @@ Run ``mutatest --help`` to see command line arguments and supported operations: --debug Turn on DEBUG level logging output. --nocov Ignore coverage files for optimization. +Using an INI config file +------------------------ + +Arguments for ``mutatest`` can be stored in a ``mutatest.ini`` config file in the directory where +you run the command. +Use the full argument names and either spaces or newlines to separate multiple values for a given +argument. +The flag commands (``--debug`` and ``--nocov``) are given boolean flags that can be interpreted by +the Python ``ConfigParser``. +If you have a configuration file any command line arguments passed to ``mutatest`` will override +the values in the ``ini`` file. + +Example INI file +~~~~~~~~~~~~~~~~ + +The contents of an example ``mutatest.ini``: + +.. code-block:: ini + + [mutatest] + + blacklist = nc su sr + exclude = + mutatest/__init__.py + mutatest/_devtools.py + mode = sd + rseed = 567 + testcmds = pytest -m 'not slow' + debug = no + nocov = no + + .. target-notes:: .. _Pytest Test Layout: https://docs.pytest.org/en/latest/goodpractices.html#choosing-a-test-layout-import-rules .. _Python AST grammar: https://docs.python.org/3/library/ast.html#abstract-grammar diff --git a/docs/conf.py b/docs/conf.py index 0d3ce21..7c1c2a2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,15 @@ def find_meta(meta): # html_theme = "alabaster" -html_theme_options = {"fixed_sidebar": True} +html_theme_options = { + "show_related": False, + "description": "“Test your tests!”", + "github_button": True, + "github_user": "EvanKepner", + "github_repo": "mutatest", + "github_type": "star", + "fixed_sidebar": True, +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". diff --git a/mutatest/__init__.py b/mutatest/__init__.py index a806ce4..5f0513c 100644 --- a/mutatest/__init__.py +++ b/mutatest/__init__.py @@ -1,6 +1,6 @@ """Mutation initialization. """ -__version__ = "1.0.1" +__version__ = "1.1.0" __title__ = "mutatest" __description__ = "Python mutation testing: test your tests!"