From 2359dde041bfe52674ce23afe7691beeb69e2994 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 3 Apr 2022 21:53:15 -0400
Subject: [PATCH 01/38] Fix error reporting bug

---
 CHANGELOG.md                | 10 ++++++++--
 xdoctest/__init__.py        |  2 +-
 xdoctest/doctest_example.py |  4 +++-
 3 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1f701caf..d480e276 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,12 +4,18 @@ We are currently working on porting this changelog to the specifications in
 [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Version 1.0.0 - Unreleased
+## Version 1.0.1 - Unreleased
+
+### Fixed
+
+* Corner case bug in error reporting
+
+
+## Version 1.0.0 - Released 2022-03-25
 
 ### Added
 * Support for Python 3.10
 
-
 ### Fixed
 * Warning in pytest8
 * Spelling errors in documentation
diff --git a/xdoctest/__init__.py b/xdoctest/__init__.py
index 6eab6a31..c6bae586 100644
--- a/xdoctest/__init__.py
+++ b/xdoctest/__init__.py
@@ -314,7 +314,7 @@ def fib(n):
 mkinit xdoctest --nomods
 '''
 
-__version__ = '1.0.0'
+__version__ = '1.0.1'
 
 
 # Expose only select submodules
diff --git a/xdoctest/doctest_example.py b/xdoctest/doctest_example.py
index 166cc742..33eefdc7 100644
--- a/xdoctest/doctest_example.py
+++ b/xdoctest/doctest_example.py
@@ -243,6 +243,8 @@ def __init__(self, docsrc, modpath=None, callname=None, num=0,
         self.failed_part = None
         self.warn_list = None
 
+        self._partfilename = None
+
         self.logged_evals = OrderedDict()
         self.logged_stdout = OrderedDict()
         self._unmatched_stdout = []
@@ -1082,7 +1084,7 @@ def overwrite_lineno(linepart):
                                 # raise Exception('foo')
                                 # continue
 
-                        if self._partfilename in line:
+                        if self._partfilename is not None and self._partfilename in line:
                             # Intercept the line corresponding to the doctest
                             tbparts = line.split(',')
                             tb_lineno = int(tbparts[-2].strip().split()[1])

From e75fa9987435df24406914f0455cd3ca717dc325 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Thu, 5 May 2022 23:48:06 -0400
Subject: [PATCH 02/38] wip

---
 xdoctest/directive.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/xdoctest/directive.py b/xdoctest/directive.py
index d105b4c4..881f82b4 100644
--- a/xdoctest/directive.py
+++ b/xdoctest/directive.py
@@ -67,6 +67,13 @@
     * Environment variables, via: ``env:<varname>==<val>``, (e.g. ``# xdoctest +REQUIRES(env:MYENVIRON==1)``)
 
 
+TODO
+----
+
+- [ ] Directive for Python version: e.g. xdoctest: +REQUIRES(Python>=3.7)
+- [ ] Directive for module version: e.g. xdoctest: +REQUIRES(module:rich>=1.0)
+
+
 CommandLine:
     python -m xdoctest.directive __doc__
 

From 3c4aee79c5075a778bcdde36ed7a387eb35b724f Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Thu, 9 Jun 2022 10:45:53 -0400
Subject: [PATCH 03/38] Make deprecations robust, add global state for
 debugging

---
 CHANGELOG.md                       |  6 ++-
 xdoctest/core.py                   | 61 ++++++++++++++++-----------
 xdoctest/directive.py              | 16 ++++++-
 xdoctest/doctest_example.py        | 31 +++++++-------
 xdoctest/global_state.py           | 19 +++++++++
 xdoctest/parser.py                 | 47 ++++++++++-----------
 xdoctest/runner.py                 |  6 +--
 xdoctest/static_analysis.py        | 11 +++--
 xdoctest/utils/util_deprecation.py | 67 ++++++++++++++++++++++++++++++
 xdoctest/utils/util_stream.py      | 10 +++--
 10 files changed, 195 insertions(+), 79 deletions(-)
 create mode 100644 xdoctest/global_state.py
 create mode 100644 xdoctest/utils/util_deprecation.py

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d480e276..6e54ba75 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,9 +7,13 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## Version 1.0.1 - Unreleased
 
 ### Fixed
-
 * Corner case bug in error reporting
 
+### Changed
+* Moved some globals into a new module called `global_state` and allowed
+  environs to enable debug print statements.
+* Added `util_deprecation` module to robustly mark features as deprecated.
+
 
 ## Version 1.0.0 - Released 2022-03-25
 
diff --git a/xdoctest/core.py b/xdoctest/core.py
index 0525c448..d9e04321 100644
--- a/xdoctest/core.py
+++ b/xdoctest/core.py
@@ -39,9 +39,7 @@
 from xdoctest import utils
 from xdoctest.docstr import docscrape_google
 from xdoctest.utils import util_import
-
-
-DEBUG = '--debug' in sys.argv
+from xdoctest import global_state
 
 
 DOCTEST_STYLES = [
@@ -147,7 +145,7 @@ def doctest_from_parts(parts, num, curr_offset):
         example._parts = parts
         return example
 
-    if DEBUG:
+    if global_state.DEBUG_CORE:
         print('Parsing docstring for callname={} in modpath={}'.format(
             callname, modpath))
 
@@ -292,7 +290,7 @@ def parse_auto_docstr_examples(docstr, *args, **kwargs):
     First try to parse google style, but if no tests are found use freeform
     style.
     """
-    if DEBUG:
+    if global_state.DEBUG_CORE:
         print('Automatic style is trying google parsing')
 
     n_found = 0
@@ -306,7 +304,7 @@ def parse_auto_docstr_examples(docstr, *args, **kwargs):
 
     # no google style tests were found, parse in freeform
     if n_found == 0:
-        if DEBUG:
+        if global_state.DEBUG_CORE:
             print('Automatic style is trying freeform parsing')
         for example in parse_freeform_docstr_examples(docstr, *args, **kwargs):
             yield example
@@ -363,7 +361,7 @@ def parse_docstr_examples(docstr, callname=None, modpath=None, lineno=1,
         1
         >>> examples = list(parse_docstr_examples(docstr, fpath='foo.txt'))
     """
-    if DEBUG:
+    if global_state.DEBUG_CORE:
         print('Parsing docstring examples for '
               'callname={} in modpath={}'.format(callname, modpath))
     if style == 'freeform':
@@ -379,7 +377,7 @@ def parse_docstr_examples(docstr, callname=None, modpath=None, lineno=1,
         raise KeyError('Unknown style={}. Valid styles are {}'.format(
             style, DOCTEST_STYLES))
 
-    if DEBUG:
+    if global_state.DEBUG_CORE:
         print('parser = {!r}'.format(parser))
 
     n_parsed = 0
@@ -389,7 +387,7 @@ def parse_docstr_examples(docstr, callname=None, modpath=None, lineno=1,
             n_parsed += 1
             yield example
     except Exception as ex:
-        if DEBUG:
+        if global_state.DEBUG_CORE:
             print('Caught an error when parsing')
         msg = ('Cannot scrape callname={} in modpath={} line={}.\n'
                'Caused by: {}\n')
@@ -420,7 +418,7 @@ def parse_docstr_examples(docstr, callname=None, modpath=None, lineno=1,
             pass
         else:
             raise
-    if DEBUG:
+    if global_state.DEBUG_CORE:
         print('Finished parsing {} examples'.format(n_parsed))
 
 
@@ -474,7 +472,7 @@ def package_calldefs(pkg_identifier, exclude=[], ignore_syntax_errors=True,
         >>> assert util_import.modpath_to_modname(modpath) == pkg_identifier
         >>> assert 'package_calldefs' in calldefs
     """
-    if DEBUG:
+    if global_state.DEBUG_CORE:
         print('Find package calldefs: pkg_identifier = {!r}'.format(pkg_identifier))
 
     if isinstance(pkg_identifier, types.ModuleType):
@@ -531,14 +529,22 @@ def parse_calldefs(module_identifier, analysis='auto'):
     """
     # backwards compatibility hacks
     if '--allow-xdoc-dynamic' in sys.argv:
-        warnings.warn(
-            '--allow-xdoc-dynamic is deprecated  and will be removed in '
-            'the future use --analysis=auto instead', DeprecationWarning)
+        from xdoctest.utils import util_deprecation
+        util_deprecation.schedule_deprecation3(
+            modname='xdoctest',
+            name='--allow-xdoc-dynamic', type='CLI flag',
+            migration='use --analysis=auto instead',
+            deprecate='1.0.0', error='1.1.0', remove='1.2.0'
+        )
         analysis = 'auto'
     if '--xdoc-force-dynamic' in sys.argv:
-        warnings.warn(
-            '--xdoc-force-dynamic is deprecated and will be removed in '
-            'the future use --analysis=dynamic instead', DeprecationWarning)
+        from xdoctest.utils import util_deprecation
+        util_deprecation.schedule_deprecation3(
+            modname='xdoctest',
+            name='--xdoc-force-dynamic', type='CLI flag',
+            migration='use --analysis=dynamic instead',
+            deprecate='1.0.0', error='1.1.0', remove='1.2.0'
+        )
         analysis = 'dynamic'
 
     if isinstance(module_identifier, types.ModuleType):
@@ -567,7 +573,7 @@ def parse_calldefs(module_identifier, analysis='auto'):
     else:
         raise KeyError(analysis)
 
-    if DEBUG:
+    if global_state.DEBUG_CORE:
         print('About to parse calldefs with do_dynamic={}'.format(do_dynamic))
 
     calldefs = None
@@ -587,6 +593,9 @@ def parse_calldefs(module_identifier, analysis='auto'):
     else:
         calldefs = static_analysis.parse_static_calldefs(fpath=module_identifier)
 
+    if global_state.DEBUG_CORE:
+        print('Found {} calldefs'.format(len(calldefs)))
+
     return calldefs
 
 
@@ -661,12 +670,16 @@ def parse_doctestables(module_identifier, exclude=[], style='auto',
             docstr = calldef.docstr
             if calldef.docstr is not None:
                 lineno = calldef.doclineno
-                for example in parse_docstr_examples(docstr, callname=callname,
-                                                     modpath=modpath,
-                                                     lineno=lineno,
-                                                     style=style,
-                                                     parser_kw=parser_kw):
-                    yield example
+                example_gen = parse_docstr_examples(
+                    docstr, callname=callname, modpath=modpath, lineno=lineno,
+                    style=style, parser_kw=parser_kw)
+                if global_state.DEBUG_CORE:  # nocover
+                    for example in example_gen:
+                        print(' * Yield example={}'.format(example))
+                        yield example
+                else:
+                    for example in example_gen:
+                        yield example
 
 
 if __name__ == '__main__':
diff --git a/xdoctest/directive.py b/xdoctest/directive.py
index 881f82b4..152a1158 100644
--- a/xdoctest/directive.py
+++ b/xdoctest/directive.py
@@ -437,7 +437,13 @@ def __nice__(self):
             return '{}{}'.format(prefix, self.name)
 
     def _unpack_args(self, num):
-        warnings.warn('Deprecated and will be removed', DeprecationWarning)
+        from xdoctest.utils import util_deprecation
+        util_deprecation.schedule_deprecation3(
+            modname='xdoctest',
+            name='Directive._unpack_args', type='method',
+            migration='there is no need to use this',
+            deprecate='1.0.0', error='1.1.0', remove='1.2.0'
+        )
         nargs = self.args
         if len(nargs) != 1:
             raise TypeError(
@@ -446,7 +452,13 @@ def _unpack_args(self, num):
         return self.args
 
     def effect(self, argv=None, environ=None):
-        warnings.warn('Deprecated use effects', DeprecationWarning)
+        from xdoctest.utils import util_deprecation
+        util_deprecation.schedule_deprecation3(
+            modname='xdoctest',
+            name='Directive.effect', type='method',
+            migration='Use Directive.effects instead',
+            deprecate='1.0.0', error='1.1.0', remove='1.2.0'
+        )
         effects = self.effects(argv=argv, environ=environ)
         if len(effects) > 1:
             raise Exception('Old method cannot handle multiple effects')
diff --git a/xdoctest/doctest_example.py b/xdoctest/doctest_example.py
index 33eefdc7..09095881 100644
--- a/xdoctest/doctest_example.py
+++ b/xdoctest/doctest_example.py
@@ -19,15 +19,10 @@
 from xdoctest import checker
 from xdoctest import exceptions
 
-# I believe the original reason for this hack was fixed in 3.9rc (The CI will
-# tell us otherwise if this is incorrect)
-# from distutils.version import LooseVersion
-# EVAL_MIGHT_RETURN_COROUTINE = LooseVersion(sys.version.split(' ')[0]) >= LooseVersion('3.9.0')
-# EVAL_MIGHT_RETURN_COROUTINE = False
-
 __devnotes__ = """
 TODO:
     - [ ] Rename DocTest to Doctest?
+    - [ ] I dont like having "example" as a suffix to this modname, can we rename?
 """
 
 
@@ -279,7 +274,8 @@ def is_disabled(self, pytest=False):
         """
         Checks for comment directives on the first line of the doctest
 
-        A doctest is disabled if it starts with any of the following patterns
+        A doctest is force-disabled if it starts with any of the following
+        patterns
 
         * ``>>> # DISABLE_DOCTEST``
         * ``>>> # SCRIPT``
@@ -289,6 +285,17 @@ def is_disabled(self, pytest=False):
         And if running in pytest, you can also use
 
         * ``>>> import pytest; pytest.skip()``
+
+        Note:
+            modern versions of xdoctest contain directives like
+            `# xdoctest: +SKIP`, which are a better way to do this.
+
+        TODO:
+            Robustly deprecate these non-standard ways of disabling a doctest.
+            Generate a warning for several versions if they are used, and
+            indicate what the replacement strategy is. Then raise an error for
+            several more versions before finally removing this code.
+
         """
         disable_patterns = [
             r'>>>\s*#\s*DISABLE',
@@ -641,16 +648,6 @@ def run(self, verbose=None, on_error=None):
                             if part.compile_mode == 'eval':
                                 # print('test_globals = {}'.format(sorted(test_globals.keys())))
                                 got_eval = eval(code, test_globals)
-                                # if EVAL_MIGHT_RETURN_COROUTINE:
-                                #     import types
-                                #     if isinstance(got_eval, types.CoroutineType):
-                                #         # In 3.9-rc (2020-mar-31) it looks like
-                                #         # eval sometimes returns coroutines. I
-                                #         # found no docs on this. Not sure if it
-                                #         # will be mainlined, but this seems to
-                                #         # fix it.
-                                #         import asyncio
-                                #         got_eval =  asyncio.run(got_eval)
                             else:
                                 exec(code, test_globals)
 
diff --git a/xdoctest/global_state.py b/xdoctest/global_state.py
new file mode 100644
index 00000000..d5d13704
--- /dev/null
+++ b/xdoctest/global_state.py
@@ -0,0 +1,19 @@
+"""
+Global state initialized at import time.
+Used for hidden arguments and developer features.
+"""
+import os
+import sys
+
+
+def _boolean_environ(key):
+    value = os.environ.get(key, '').lower()
+    TRUTHY_ENVIRONS = {'true', 'on', 'yes', '1'}
+    return value in TRUTHY_ENVIRONS
+
+
+DEBUG = _boolean_environ('XDOCTEST_DEBUG') or '--debug' in sys.argv
+
+DEBUG_PARSER = DEBUG or _boolean_environ('XDOCTEST_DEBUG_PARSER')
+DEBUG_CORE = DEBUG or _boolean_environ('XDOCTEST_DEBUG_CORE')
+DEBUG_RUNNER = DEBUG or _boolean_environ('XDOCTEST_DEBUG_RUNNER')
diff --git a/xdoctest/parser.py b/xdoctest/parser.py
index 040c6efe..d0f336a4 100644
--- a/xdoctest/parser.py
+++ b/xdoctest/parser.py
@@ -45,10 +45,9 @@
 from xdoctest import exceptions
 from xdoctest import doctest_part
 from xdoctest import static_analysis as static
+from xdoctest import global_state
 
 
-DEBUG = '--debug' in sys.argv
-
 INDENT_RE = re.compile(r'^([ ]*)(?=\S)', re.MULTILINE)
 
 
@@ -143,7 +142,7 @@ def parse(self, string, info=None):
             >>> assert len(doctest_parts) == 6
             >>> len(doctest_parts)
         """
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             print('\n===== PARSE ====')
         if sys.version_info.major == 2:  # nocover
             string = utils.ensure_unicode(string)
@@ -172,7 +171,7 @@ def parse(self, string, info=None):
                 failpoint = '_group_labeled_lines'
             elif all_parts is None:
                 failpoint = '_package_groups'
-            if DEBUG:
+            if global_state.DEBUG_PARSER:
                 print('<FAILPOINT>')
                 print('!!! FAILED !!!')
                 print('failpoint = {!r}'.format(failpoint))
@@ -199,12 +198,12 @@ def parse(self, string, info=None):
             raise exceptions.DoctestParseError(
                 'Failed to parse doctest in {}'.format(failpoint),
                 string=string, info=info, orig_ex=orig_ex)
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             print('\n===== FINISHED PARSE ====')
         return all_parts
 
     def _package_groups(self, grouped_lines):
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             import ubelt as ub
             print('<PACKAGE LABEL GROUPS>')
             print('grouped_lines = {}'.format(ub.repr2(grouped_lines, nl=2)))
@@ -219,7 +218,7 @@ def _package_groups(self, grouped_lines):
                 text_part = '\n'.join(chunk)
                 yield text_part
                 lineno += len(chunk)
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             print('</PACKAGE LABEL GROUPS>')
 
     def _package_chunk(self, raw_source_lines, raw_want_lines, lineno=0):
@@ -243,7 +242,7 @@ def _package_chunk(self, raw_source_lines, raw_want_lines, lineno=0):
             'string'
 
         """
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             print('<PACKAGE CHUNK>')
         match = INDENT_RE.search(raw_source_lines[0])
         line_indent = 0 if match is None else (match.end() - match.start())
@@ -256,11 +255,11 @@ def _package_chunk(self, raw_source_lines, raw_want_lines, lineno=0):
 
         exec_source_lines = [p[4:] for p in source_lines]
 
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             print(' * locate ps1 lines')
         # Find the line number of each standalone statement
         ps1_linenos, mode_hint = self._locate_ps1_linenos(source_lines)
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             print('mode_hint = {!r}'.format(mode_hint))
             print(' * located ps1 lines')
 
@@ -336,7 +335,7 @@ def slice_example(s1, s2, want_lines=None):
             assert mode_hint in {'eval', 'exec', 'single'}
             example.compile_mode = mode_hint
 
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             print('example.compile_mode = {!r}'.format(example.compile_mode))
             print('<YIELD CHUNK>')
         yield example
@@ -351,7 +350,7 @@ def _group_labeled_lines(self, labeled_lines):
                 lines.  Executable parts are returned as a tuple of source
                 lines and an optional "want" statement.
         """
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             print('<GROUP LABEL LINES>')
         # Now that lines have types, groups them. This could have done this
         # above, but functionality is split for readability.
@@ -363,7 +362,7 @@ def _group_labeled_lines(self, labeled_lines):
         groups = []
         current = []
         state = None
-        if DEBUG > 4:
+        if global_state.DEBUG_PARSER > 4:
             print('labeled_lines = {!r}'.format(labeled_lines))
 
         # Need to ensure that old-style continuations with want statements are
@@ -380,7 +379,7 @@ def _group_labeled_lines(self, labeled_lines):
         if current:
             groups.append((state, current))
 
-        if DEBUG > 4:
+        if global_state.DEBUG_PARSER > 4:
             print('groups = {!r}'.format(groups))
 
         # need to merge consecutive dsrc groups without want statements
@@ -429,7 +428,7 @@ def _group_labeled_lines(self, labeled_lines):
         if prev_source:
             grouped_lines.append((prev_source, ''))
 
-        if DEBUG > 1:  # nocover
+        if global_state.DEBUG_PARSER > 1:  # nocover
             print('</GROUP LABEL LINES>')
         return grouped_lines
 
@@ -727,7 +726,7 @@ def _label_docsrc_lines(self, string):
         for line_idx, line in line_iter:
             match = INDENT_RE.search(line)
             line_indent = 0 if match is None else (match.end() - match.start())
-            if DEBUG:  # nocover
+            if global_state.DEBUG_PARSER:  # nocover
                 print('Next line {}: {}'.format(line_idx, line))
                 print('state_indent = {!r}'.format(state_indent))
                 print('match = {!r}'.format(match))
@@ -796,10 +795,10 @@ def _label_docsrc_lines(self, string):
             if curr_state in {DSRC, DCNT}:
                 # source parts may consume more than one line
                 try:
-                    if DEBUG:  # nocover
+                    if global_state.DEBUG_PARSER:  # nocover
                         print('completing source')
                     for part, norm_line in _complete_source(line, state_indent, line_iter):
-                        if DEBUG > 4:  # nocover
+                        if global_state.DEBUG_PARSER > 4:  # nocover
                             print('Append Completion Line:')
                             print('part = {!r}'.format(part))
                             print('norm_line = {!r}'.format(norm_line))
@@ -811,7 +810,7 @@ def _label_docsrc_lines(self, string):
                 except exceptions.IncompleteParseError:
                     raise
                 except SyntaxError:
-                    if DEBUG:  # nocover
+                    if global_state.DEBUG_PARSER:  # nocover
                         print('<LABEL FAIL>')
                         # print('next(line_iter) = {!r}'.format(line_iter))
                         print('state_indent = {!r}'.format(state_indent))
@@ -829,9 +828,9 @@ def _label_docsrc_lines(self, string):
                 labeled_lines.append((curr_state, line))
             prev_state = curr_state
 
-        if DEBUG > 1:  # nocover
+        if global_state.DEBUG_PARSER > 1:  # nocover
             import ubelt as ub
-            # if DEBUG > 3:
+            # if global_state.DEBUG_PARSER > 3:
             #     print('string = {!r}'.format(string))
             print('<FINISH LABELED LINES')
             print('labeled_lines = {}'.format(ub.repr2(labeled_lines, nl=1)))
@@ -899,7 +898,7 @@ def _complete_source(line, state_indent, line_iter):
                         error = False
 
                 if error:
-                    if DEBUG:
+                    if global_state.DEBUG_PARSER:
                         print(' * !!!ERROR!!!')
                         print(' * source_parts = {!r}'.format(source_parts))
                         print(' * prefix = {!r}'.format(prefix))
@@ -912,7 +911,7 @@ def _complete_source(line, state_indent, line_iter):
             source_parts.append(suffix)
             yield next_line, norm_line
     except StopIteration:
-        if DEBUG:
+        if global_state.DEBUG_PARSER:
             import ubelt as ub
             print('<FAIL DID NOT COMPLETE SOURCE>')
             import traceback
@@ -943,7 +942,7 @@ def _complete_source(line, state_indent, line_iter):
             'ill-formed doctest: all parts have been processed '
             'but the doctest source is not balanced')
     else:
-        if DEBUG > 1:
+        if global_state.DEBUG_PARSER > 1:
             import ubelt as ub
             print('<SUCCESS COMPLETED SOURCE>')
             # print(' * line_iter = {!r}'.format(line_iter))
diff --git a/xdoctest/runner.py b/xdoctest/runner.py
index ae406577..f1dba062 100644
--- a/xdoctest/runner.py
+++ b/xdoctest/runner.py
@@ -58,6 +58,7 @@
 import types
 import warnings
 import sys
+from xdoctest import global_state
 
 
 def log(msg, verbose):
@@ -65,9 +66,6 @@ def log(msg, verbose):
         print(msg)
 
 
-DEBUG = '--debug' in sys.argv
-
-
 def doctest_callable(func):
     """
     Executes doctests an in-memory function or class.
@@ -170,7 +168,7 @@ def doctest_module(module_identifier=None, command=None, argv=None, exclude=[],
         >>> from xdoctest import runner
         >>> result = doctest_module('xdoctest.static_analysis::parse_static_value')
     """
-    _log = partial(log, verbose=DEBUG)
+    _log = partial(log, verbose=global_state.DEBUG_RUNNER)
     _log('------+ DEBUG +------')
     _log('CALLED doctest_module')
     _log('exclude = {!r}'.format(exclude))
diff --git a/xdoctest/static_analysis.py b/xdoctest/static_analysis.py
index c46cd31a..0a7b88f5 100644
--- a/xdoctest/static_analysis.py
+++ b/xdoctest/static_analysis.py
@@ -679,10 +679,13 @@ def parse_static_calldefs(source=None, fpath=None):
 
 
 def parse_calldefs(source=None, fpath=None):
-    import warnings
-    warnings.warn((
-        'parse_calldefs is deprecated '
-        'use parse_static_calldefs instead'), DeprecationWarning)
+    from xdoctest.utils import util_deprecation
+    util_deprecation.schedule_deprecation3(
+        modname='xdoctest',
+        name='parse_calldefs', type='function',
+        migration='use parse_static_calldefs instead',
+        deprecate='1.0.0', error='1.1.0', remove='1.2.0'
+    )
     return parse_static_calldefs(source=source, fpath=fpath)
 
 
diff --git a/xdoctest/utils/util_deprecation.py b/xdoctest/utils/util_deprecation.py
new file mode 100644
index 00000000..f3eff66b
--- /dev/null
+++ b/xdoctest/utils/util_deprecation.py
@@ -0,0 +1,67 @@
+"""
+Utilities for helping robustly deprecate features.
+"""
+import warnings
+
+
+DEP_SCHEDULE_1 = dict(deprecate='0.9.6', remove='1.0.0')
+
+
+def paragraph(text):
+    r"""
+    Wraps multi-line strings and restructures the text to remove all newlines,
+    heading, trailing, and double spaces.
+
+    Useful for writing log messages
+
+    Args:
+        text (str): typically a multiline string
+
+    Returns:
+        str: the reduced text block
+
+    Example:
+        >>> import ubelt as ub
+        >>> text = (
+        >>>     '''
+        >>>     Lorem ipsum dolor sit amet, consectetur adipiscing
+        >>>     elit, sed do eiusmod tempor incididunt ut labore et
+        >>>     dolore magna aliqua.
+        >>>     ''')
+        >>> out = ub.paragraph(text)
+        >>> assert chr(10) in text
+        >>> assert chr(10) not in out
+        >>> print('text = {!r}'.format(text))
+        >>> print('out = {!r}'.format(out))
+    """
+    import re
+    out = re.sub(r'\s\s*', ' ', text).strip()
+    return out
+
+
+def schedule_deprecation3(modname, migration='', name='?', type='?', deprecate=None, error=None, remove=None):  # nocover
+    """
+    Deprecation machinery to help provide users with a smoother transition.
+    """
+    import sys
+    from distutils.version import LooseVersion
+    module = sys.modules[modname]
+    current = LooseVersion(module.__version__)
+    deprecate = None if deprecate is None else LooseVersion(deprecate)
+    remove = None if remove is None else LooseVersion(remove)
+    error = None if error is None else LooseVersion(error)
+    if deprecate is None or current >= deprecate:
+        if migration is None:
+            migration = ''
+        msg = paragraph(
+            '''
+            The "{name}" {type} was deprecated in {deprecate}, will cause
+            an error in {error} and will be removed in {remove}. The current
+            version is {current}. {migration}
+            ''').format(**locals()).strip()
+        if remove is not None and current >= remove:
+            raise AssertionError('forgot to remove a deprecated function')
+        if error is not None and current >= error:
+            raise DeprecationWarning(msg)
+        else:
+            warnings.warn(msg, DeprecationWarning)
diff --git a/xdoctest/utils/util_stream.py b/xdoctest/utils/util_stream.py
index 03551073..8685a330 100644
--- a/xdoctest/utils/util_stream.py
+++ b/xdoctest/utils/util_stream.py
@@ -140,9 +140,13 @@ class CaptureStdout(CaptureStream):
     def __init__(self, suppress=True, enabled=True, **kwargs):
         _misspelled_varname = 'supress'
         if _misspelled_varname in kwargs:  # nocover
-            import warnings
-            warnings.warn(
-                'Argument of CaptureStdout {} is misspelled and deprecated. Use suppress instead'.format(_misspelled_varname), DeprecationWarning)
+            from xdoctest.utils import util_deprecation
+            util_deprecation.schedule_deprecation3(
+                modname='xdoctest',
+                name='supress', type='Argument of CaptureStdout',
+                migration='Use suppress instead',
+                deprecate='1.0.0', error='1.1.0', remove='1.2.0'
+            )
             suppress = kwargs.pop(_misspelled_varname)
             if len(kwargs) > 0:
                 raise ValueError('unexpected args: {}'.format(kwargs))

From 9195cd8c66bc18cbb34730c3816a07d519c22173 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Thu, 9 Jun 2022 10:58:43 -0400
Subject: [PATCH 04/38] Debugging notes

---
 xdoctest/doctest_example.py | 11 ++++++++++-
 xdoctest/global_state.py    |  1 +
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/xdoctest/doctest_example.py b/xdoctest/doctest_example.py
index 09095881..7655dc22 100644
--- a/xdoctest/doctest_example.py
+++ b/xdoctest/doctest_example.py
@@ -18,6 +18,7 @@
 from xdoctest import parser
 from xdoctest import checker
 from xdoctest import exceptions
+from xdoctest import global_state
 
 __devnotes__ = """
 TODO:
@@ -470,9 +471,17 @@ def _import_module(self):
         if self.module is None:
             if not self.modname.startswith('<'):
                 # self.module = utils.import_module_from_path(self.modpath, index=0)
+                if global_state.DEBUG_DOCTEST:
+                    print('Pre-importing modpath = {}'.format(self.modpath))
                 try:
+                    # Note: there is a possibility of conflicts that arises
+                    # here depending on your local environment. We may want to
+                    # try and detect that.
                     self.module = utils.import_module_from_path(self.modpath, index=-1)
                 except RuntimeError as ex:
+                    if global_state.DEBUG_DOCTEST:
+                        print('sys.path={}'.format(sys.path))
+                        print('Failed to pre-import modpath = {}'.format(self.modpath))
                     msg_parts = [
                         ('XDoctest failed to pre-import the module '
                          'containing the doctest.')
@@ -708,7 +717,7 @@ def run(self, verbose=None, on_error=None):
                 except Exception as _ex_dbg:
                     ex_type, ex_value, tb = sys.exc_info()
 
-                    DEBUG = 0
+                    DEBUG = global_state.DEBUG_DOCTEST
                     if DEBUG:
                         print('_ex_dbg = {!r}'.format(_ex_dbg))
                         print('<DEBUG: doctest encountered exception>', file=sys.stderr)
diff --git a/xdoctest/global_state.py b/xdoctest/global_state.py
index d5d13704..e64a733b 100644
--- a/xdoctest/global_state.py
+++ b/xdoctest/global_state.py
@@ -17,3 +17,4 @@ def _boolean_environ(key):
 DEBUG_PARSER = DEBUG or _boolean_environ('XDOCTEST_DEBUG_PARSER')
 DEBUG_CORE = DEBUG or _boolean_environ('XDOCTEST_DEBUG_CORE')
 DEBUG_RUNNER = DEBUG or _boolean_environ('XDOCTEST_DEBUG_RUNNER')
+DEBUG_DOCTEST = DEBUG or _boolean_environ('XDOCTEST_DEBUG_DOCTEST')

From ce2961d3c1e4c006f825484a0ddc7fc2c95f8ed1 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Thu, 9 Jun 2022 19:48:13 -0400
Subject: [PATCH 05/38] fix paragraph doctest

---
 xdoctest/utils/util_deprecation.py | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/xdoctest/utils/util_deprecation.py b/xdoctest/utils/util_deprecation.py
index f3eff66b..930fc417 100644
--- a/xdoctest/utils/util_deprecation.py
+++ b/xdoctest/utils/util_deprecation.py
@@ -21,14 +21,13 @@ def paragraph(text):
         str: the reduced text block
 
     Example:
-        >>> import ubelt as ub
         >>> text = (
         >>>     '''
         >>>     Lorem ipsum dolor sit amet, consectetur adipiscing
         >>>     elit, sed do eiusmod tempor incididunt ut labore et
         >>>     dolore magna aliqua.
         >>>     ''')
-        >>> out = ub.paragraph(text)
+        >>> out = paragraph(text)
         >>> assert chr(10) in text
         >>> assert chr(10) not in out
         >>> print('text = {!r}'.format(text))

From 8e6f1744ea4e137f5e1331dde8753607d2b0d1ba Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 12 Jun 2022 13:54:12 -0400
Subject: [PATCH 06/38] doc update

---
 xdoctest/docstr/docscrape_google.py | 24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/xdoctest/docstr/docscrape_google.py b/xdoctest/docstr/docscrape_google.py
index 306d555c..d925e04a 100644
--- a/xdoctest/docstr/docscrape_google.py
+++ b/xdoctest/docstr/docscrape_google.py
@@ -1,6 +1,13 @@
 # -*- coding: utf-8 -*-
 """
 Handles parsing of information out of google style docstrings
+
+It is not clear which of these `GoogleStyleDocs1`_ `GoogleStyleDocs2`_ is *the*
+standard or if there is one.
+
+References:
+    [GoogleStyleDocs1] https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google
+    [GoogleStyleDocs2] http://www.sphinx-doc.org/en/stable/ext/example_google.html#example-google
 """
 from __future__ import absolute_import, division, print_function, unicode_literals
 import re
@@ -71,6 +78,12 @@ def parse_google_returns(docstr, return_annot=None):
 
 def parse_google_retblock(lines, return_annot=None):
     r"""
+    Parse information out of a returns or yeilds block.
+
+    A returns or yeids block should be formatted as one or more
+    '{type}:{description}' strings. The description can occupy multiple lines,
+    but the indentation should increase.
+
     Args:
         lines (str): unindented lines from a Returns or Yields section
         return_annot (str): the return type annotation (if one exists)
@@ -120,7 +133,6 @@ def parse_google_retblock(lines, return_annot=None):
         ... ])))
         >>> assert len(hints) == 0
         ...
-
     """
     if return_annot is not None:
         # If the function has a return type annotation then the return block
@@ -147,6 +159,11 @@ def finalize(retdict):
                     # Finalize and return any previously constructed type hint
                     yield finalize(retdict)
                     retdict = None
+                # FIXME:
+                # This doesn't quite work if ":" is part of the type
+                # definition.  Not sure if it can be. Needs better parsing
+                # to ensure the ":" is actually the separator between
+                # type and desc
                 if ':' in line:
                     parts = line.split(':')
                     retdict = {
@@ -169,11 +186,6 @@ def parse_google_argblock(lines):
     Args:
         lines (str): the unindented lines from an Args docstring section
 
-    References:
-        # It is not clear which of these is *the* standard or if there is one
-        https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google
-        http://www.sphinx-doc.org/en/stable/ext/example_google.html#example-google
-
     Example:
         >>> # Test various ways that arglines can be written
         >>> line_list = [

From db2e60f25bad64b35373193f912bec4670eca362 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Tue, 14 Jun 2022 21:40:11 -0400
Subject: [PATCH 07/38] Enhance google docs return type parser

---
 CHANGELOG.md                        |  2 ++
 xdoctest/docstr/docscrape_google.py | 29 ++++++++++++++++++++++++-----
 2 files changed, 26 insertions(+), 5 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6e54ba75..dd60fe35 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 * Moved some globals into a new module called `global_state` and allowed
   environs to enable debug print statements.
 * Added `util_deprecation` module to robustly mark features as deprecated.
+* Modified the google style return type parser to return a type if the 
+  only content is some parsable python code.
 
 
 ## Version 1.0.0 - Released 2022-03-25
diff --git a/xdoctest/docstr/docscrape_google.py b/xdoctest/docstr/docscrape_google.py
index d925e04a..11f60551 100644
--- a/xdoctest/docstr/docscrape_google.py
+++ b/xdoctest/docstr/docscrape_google.py
@@ -94,7 +94,6 @@ def parse_google_retblock(lines, return_annot=None):
     Example:
         >>> # Test various ways that retlines can be written
         >>> assert len(list(parse_google_retblock('list: a desc'))) == 1
-        >>> assert len(list(parse_google_retblock('no type, just desc'))) == 0
         >>> # ---
         >>> hints = list(parse_google_retblock('\n'.join([
         ...     'entire line can be desc',
@@ -126,12 +125,14 @@ def parse_google_retblock(lines, return_annot=None):
         ... ])))
         >>> assert len(hints) == 4
         >>> # ---
+        >>> # If the colon is not specified nothing will be parsed
+        >>> # according to the "official" spec, but lets try and do it anyway
         >>> hints = list(parse_google_retblock('\n'.join([
-        ...     # If the colon is not specified nothing will be parsed
         ...     'list',
         ...     'Tuple[int, str]',
         ... ])))
-        >>> assert len(hints) == 0
+        >>> assert len(hints) == 2
+        >>> assert len(list(parse_google_retblock('no type, just desc'))) == 1
         ...
     """
     if return_annot is not None:
@@ -171,8 +172,26 @@ def finalize(retdict):
                         'desc': [':'.join(parts[1:]).strip()],
                     }
                 else:
-                    # warning (malformatted google docstring)
-                    pass
+                    # warning (malformatted google docstring) We should support
+                    # the case where they just specify the type and no
+                    # description.
+                    USE_TYPE_HACK = 1
+                    if USE_TYPE_HACK:
+                        import ast
+                        try:
+                            ast.parse(line.strip())
+                        except Exception:
+                            # Not parseable, assume this is a description.
+                            retdict = {
+                                'type': None,
+                                'desc': [line.strip()],
+                            }
+                        else:
+                            # Parseable, assume this is a type
+                            retdict = {
+                                'type': line.strip(),
+                                'desc': [],
+                            }
             else:
                 # Lines with indentation should extend previous descriptions.
                 if retdict is not None:

From 958d939995b78e7f13ff8469752c851587dba48a Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 19 Jun 2022 17:29:24 -0400
Subject: [PATCH 08/38] Fix issue with tests being not marked as skipped

---
 CHANGELOG.md                |  1 +
 xdoctest/doctest_example.py | 10 ++++++++++
 xdoctest/doctest_part.py    | 12 ++++++++++++
 3 files changed, 23 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index dd60fe35..3b6eff40 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Fixed
 * Corner case bug in error reporting
+* Doctests that never run any code are now correctly marked as skipped 
 
 ### Changed
 * Moved some globals into a new module called `global_state` and allowed
diff --git a/xdoctest/doctest_example.py b/xdoctest/doctest_example.py
index 7655dc22..7d53734e 100644
--- a/xdoctest/doctest_example.py
+++ b/xdoctest/doctest_example.py
@@ -622,12 +622,22 @@ def run(self, verbose=None, on_error=None):
                     self._skipped_parts.append(part)
                     continue
 
+                import ubelt as ub
+                print('part.exec_lines = {}'.format(ub.repr2(part.exec_lines, nl=1)))
+                flag = part.has_any_code()
+                print(f'flag={flag}')
+                if not part.has_any_code():
+                    print('Skipping')
+                    self._skipped_parts.append(part)
+                    continue
+
                 try:
                     # Compile code, handle syntax errors
                     #   part.compile_mode can be single, exec, or eval.
                     #   Typically single is used instead of eval
                     self._partfilename = '<doctest:' + self.node + '>'
                     source_text = part.compilable_source()
+
                     code = compile(
                         source_text, mode=part.compile_mode,
                         filename=self._partfilename,
diff --git a/xdoctest/doctest_part.py b/xdoctest/doctest_part.py
index 4fbcb2d7..04922536 100644
--- a/xdoctest/doctest_part.py
+++ b/xdoctest/doctest_part.py
@@ -72,6 +72,18 @@ def compilable_source(self):
         else:
             return '\n'.join(self.exec_lines)
 
+    def has_any_code(self):
+        """
+        Heuristic to check if there is any runnable code in this doctest.  We
+        currently just check that not every line is a comment, which helps the
+        runner count a test as skipped if only lines with comments "ran".
+        """
+        slines = [line.strip() for line in self.exec_lines]
+        return not all(
+            not line or line.startswith('#')
+            for line in slines
+        )
+
     @property
     def directives(self):
         """

From e07d5ec72fae70d4fd0195e28015b3444ede9778 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Wed, 22 Jun 2022 12:22:05 -0400
Subject: [PATCH 09/38] Remove bad prints

---
 xdoctest/directive.py       | 3 +++
 xdoctest/doctest_example.py | 5 -----
 2 files changed, 3 insertions(+), 5 deletions(-)

diff --git a/xdoctest/directive.py b/xdoctest/directive.py
index 152a1158..219669bc 100644
--- a/xdoctest/directive.py
+++ b/xdoctest/directive.py
@@ -655,6 +655,9 @@ def _is_requires_satisfied(arg, argv=None, environ=None):
 
     arg_lower = arg.lower()
 
+    # TODO: better chained version parsing
+    # Should be able to specify Python>=3.8,Python!=3.8.1,env:HASIT<3
+
     if arg.startswith('-'):
         if argv is None:
             argv = sys.argv
diff --git a/xdoctest/doctest_example.py b/xdoctest/doctest_example.py
index 7d53734e..e50236f4 100644
--- a/xdoctest/doctest_example.py
+++ b/xdoctest/doctest_example.py
@@ -622,12 +622,7 @@ def run(self, verbose=None, on_error=None):
                     self._skipped_parts.append(part)
                     continue
 
-                import ubelt as ub
-                print('part.exec_lines = {}'.format(ub.repr2(part.exec_lines, nl=1)))
-                flag = part.has_any_code()
-                print(f'flag={flag}')
                 if not part.has_any_code():
-                    print('Skipping')
                     self._skipped_parts.append(part)
                     continue
 

From 5b8ba6e3d114025e4b7c0e4e677b9b9a593118f1 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Mon, 27 Jun 2022 14:02:17 -0400
Subject: [PATCH 10/38] Update docstr code

---
 CHANGELOG.md                        |   2 +
 xdoctest/docstr/docscrape_google.py | 511 +++++++++++++++-------------
 2 files changed, 280 insertions(+), 233 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3b6eff40..4c7573ef 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -16,6 +16,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 * Added `util_deprecation` module to robustly mark features as deprecated.
 * Modified the google style return type parser to return a type if the 
   only content is some parsable python code.
+* Modified docscrape google to allow for parsing of `*args` and `**kwargs` in
+  args blocks. May move this to a standalone package soon.
 
 
 ## Version 1.0.0 - Released 2022-03-25
diff --git a/xdoctest/docstr/docscrape_google.py b/xdoctest/docstr/docscrape_google.py
index 11f60551..c42a4953 100644
--- a/xdoctest/docstr/docscrape_google.py
+++ b/xdoctest/docstr/docscrape_google.py
@@ -5,6 +5,11 @@
 It is not clear which of these `GoogleStyleDocs1`_ `GoogleStyleDocs2`_ is *the*
 standard or if there is one.
 
+This may be moved to a standalone package similar to:
+
+    * https://pypi.org/project/docstring-parser/
+    * https://pypi.org/project/numpydoc/
+
 References:
     [GoogleStyleDocs1] https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google
     [GoogleStyleDocs2] http://www.sphinx-doc.org/en/stable/ext/example_google.html#example-google
@@ -17,6 +22,239 @@
 from xdoctest import exceptions
 from xdoctest.utils.util_str import ensure_unicode
 
+DocBlock = collections.namedtuple('DocBlock', ['text', 'offset'])
+
+
+def split_google_docblocks(docstr):
+    """
+    Breaks a docstring into parts defined by google style
+
+    Args:
+        docstr (str): a docstring
+
+    Returns:
+        List[Tuple[str, DocBlock[str, int]]]:
+            list of 2-tuples where the first item is a google style docstring
+            tag and the second item is the bock corresponding to that tag. The
+            block itself is a 2-tuple where the first item is the unindented
+            text and the second item is the line offset indicating that blocks
+            location in the docstring.
+
+    Note:
+        Unknown or "freeform" sections are given a generic "__DOC__" tag.
+        A section tag may be specified multiple times.
+
+    CommandLine:
+        xdoctest xdoctest.docstr.docscrape_google split_google_docblocks:2
+
+    Example:
+        >>> from xdoctest.docstr.docscrape_google import *  # NOQA
+        >>> from xdoctest import utils
+        >>> docstr = utils.codeblock(
+        ...     '''
+        ...     one line description
+        ...
+        ...     multiline
+        ...     description
+        ...
+        ...     Args:
+        ...         foo: bar
+        ...
+        ...     Returns:
+        ...         None
+        ...
+        ...     Example:
+        ...         >>> print('eg1')
+        ...         eg1
+        ...
+        ...     Example:
+        ...         >>> print('eg2')
+        ...         eg2
+        ...     ''')
+        >>> groups = split_google_docblocks(docstr)
+        >>> assert len(groups) == 5
+        >>> [g[0] for g in groups]
+        ['__DOC__', 'Args', 'Returns', 'Example', 'Example']
+
+    Example:
+        >>> from xdoctest.docstr.docscrape_google import *  # NOQA
+        >>> docstr = split_google_docblocks.__doc__
+        >>> groups = split_google_docblocks(docstr)
+
+    Example:
+        >>> from xdoctest.docstr.docscrape_google import *  # NOQA
+        >>> from xdoctest import utils
+        >>> docstr = utils.codeblock(
+        ...     '''
+        ...      a description with a leading space
+        ...
+        ...     Example:
+        ...         >>> foobar
+        ...     ''')
+        >>> groups = split_google_docblocks(docstr)
+        >>> print('groups = {!r}'.format(groups))
+
+    Example:
+        >>> from xdoctest.docstr.docscrape_google import *  # NOQA
+        >>> from xdoctest import utils
+        >>> docstr = utils.codeblock(
+        ...     '''
+        ...     Example:
+        ...         >>> foobar
+        ...     ''')
+        >>> # Check that line offsets are valid if the first line is not blank
+        >>> groups = split_google_docblocks(docstr)
+        >>> offset = groups[0][1][1]
+        >>> print('offset = {!r}'.format(offset))
+        >>> assert offset == 0
+        >>> # Check that line offsets are valid if the first line is blank
+        >>> groups = split_google_docblocks(chr(10) + docstr)
+        >>> offset = groups[0][1][1]
+        >>> print('offset = {!r}'.format(offset))
+        >>> assert offset == 1
+    """
+    if not isinstance(docstr, six.string_types):
+        raise TypeError('Input docstr must be a string. Got {} instead'.format(
+            type(docstr)))
+
+    def get_indentation(line_):
+        """ returns number of preceding spaces """
+        return len(line_) - len(line_.lstrip())
+
+    # Parse out initial documentation lines
+    # Then parse out the blocked lines.
+    docstr = ensure_unicode(docstr)
+
+    docstr = textwrap.dedent(docstr)
+    docstr_lines = docstr.split('\n')
+    line_indent = [get_indentation(line) for line in docstr_lines]
+    line_len = [len(line) for line in docstr_lines]
+
+    # The first line may not have the correct indentation if it starts
+    # right after the triple quotes. Adjust it in this case to ensure that
+    # base indent is always 0
+    adjusted = False
+    is_nonzero = [len_ > 0 for len_ in line_len]
+    if len(line_indent) >= 2:
+        if line_len[0] != 0:
+            indents = [x for x, f in zip(line_indent, is_nonzero) if f]
+            if len(indents) >= 2:
+                indent_adjust = min(indents[1:])
+                line_indent[0] += indent_adjust
+                line_len[0] += indent_adjust
+                docstr_lines[0] = (' ' * indent_adjust) + docstr_lines[0]
+                adjusted = True
+    if adjusted:
+        # Redo prepreocessing, but this time on a rectified input
+        docstr = textwrap.dedent('\n'.join(docstr_lines))
+        docstr_lines = docstr.split('\n')
+        line_indent = [get_indentation(line) for line in docstr_lines]
+        line_len = [len(line) for line in docstr_lines]
+
+    indents = [x for x, f in zip(line_indent, is_nonzero) if f]
+    if False and len(indents) >= 1:
+        if indents[0] != 0:
+            # debug info
+            print('INDENTATION ERROR IN PARSING DOCSTRING')
+            print('CHECK TO MAKE SURE YOU USED A RAW STRING IF YOU USE "\\n"')
+            # TODO: Report this error with line number and file information
+            print('Docstring:')
+            print('----------')
+            print(docstr)
+            print('----------')
+            raise exceptions.MalformedDocstr('malformed google docstr')
+
+    base_indent = 0
+    # We will group lines by their indentation.
+    # Rectify empty lines by giving them their parent's indentation.
+    true_indent = []
+    prev_indent = None
+    for indent_, len_ in zip(line_indent, line_len):
+        if len_ == 0:
+            # Empty lines take on their parents indentation
+            indent_ = prev_indent
+        true_indent.append(indent_)
+        prev_indent = indent_
+
+    # List of google style tags grouped by alias
+    tag_groups = [
+        ['Args', 'Arguments', 'Parameters', 'Other Parameters'],
+        ['Kwargs', 'Keyword Args', 'Keyword Arguments'],
+        ['Warns', 'Warning', 'Warnings'],
+        ['Returns', 'Return'],
+        ['Example', 'Examples'],
+        ['Doctest'],
+        ['Note', 'Notes'],
+        ['Yields', 'Yield'],
+        ['Attributes'],
+        ['Methods'],
+        ['Raises'],
+        ['References'],
+        ['See Also'],
+        ['Todo'],
+    ]
+    # Map aliased tags to a canonical name (the first item in the group).
+    tag_aliases = dict([(item, group[0]) for group in tag_groups for item in group])
+    # Allow for single or double colon (support for pytorch)
+    tag_pattern = '^' + '(' + '|'.join(tag_aliases.keys()) + ') *::? *$'
+
+    # Label lines by their group-id
+    group_id = 0
+    prev_indent = 0
+    group_list = []
+    in_tag = False
+    for line_num, (line, indent_) in enumerate(zip(docstr_lines, true_indent)):
+        if re.match(tag_pattern, line):
+            # Check if we can look ahead
+            if line_num + 1 < len(docstr_lines):
+                # A tag is only valid if its next line is properly indented,
+                # empty, or is a tag itself.
+                indent_increase = true_indent[line_num + 1] > base_indent
+                indent_zero = line_len[line_num + 1] == 0
+                matches_tag = re.match(tag_pattern, docstr_lines[line_num + 1])
+                if (indent_increase or indent_zero or matches_tag):
+                    group_id += 1
+                    in_tag = True
+            else:
+                group_id += 1
+                in_tag = True
+        # If the indentation goes back to the base, then we have left the tag
+        elif in_tag and indent_ != prev_indent and indent_ == base_indent:
+            group_id += 1
+            in_tag = False
+        group_list.append(group_id)
+        prev_indent = indent_
+
+    assert len(docstr_lines) == len(group_list)
+
+    # Group docstr lines by group list
+    groups_ = collections.defaultdict(list)
+    for groupid, line in zip(group_list, docstr_lines):
+        groups_[groupid].append(line)
+
+    groups = []
+    line_offset = 0
+    for k, lines in groups_.items():
+        if len(lines) == 0 or (len(lines) == 1 and len(lines[0]) == 0):
+            line_offset += len(lines)
+            continue
+        elif len(lines) >= 1 and re.match(tag_pattern, lines[0]):
+            # An encoded google sub-block
+            key = lines[0].strip().rstrip(':')
+            val = lines[1:]
+            subblock = textwrap.dedent('\n'.join(val))
+        else:
+            # A top level text documentation block
+            key = '__DOC__'
+            val = lines[:]
+            subblock = '\n'.join(val)
+
+        key = tag_aliases.get(key, key)
+        block = DocBlock(subblock, line_offset)
+        groups.append((key, block))
+        line_offset += len(lines)
+    return groups
+
 
 def parse_google_args(docstr):
     r"""
@@ -48,7 +286,9 @@ def parse_google_returns(docstr, return_annot=None):
 
     Args:
         docstr (str): a google-style docstring
-        return_annot (str): the return type annotation (if one exists)
+
+        return_annot (str | None):
+            the return type annotation (if one exists)
 
     Yields:
         Dict[str, str]: dictionaries of return value hints
@@ -81,12 +321,15 @@ def parse_google_retblock(lines, return_annot=None):
     Parse information out of a returns or yeilds block.
 
     A returns or yeids block should be formatted as one or more
-    '{type}:{description}' strings. The description can occupy multiple lines,
-    but the indentation should increase.
+    ``'{type}:{description}'`` strings. The description can occupy multiple
+    lines, but the indentation should increase.
 
     Args:
-        lines (str): unindented lines from a Returns or Yields section
-        return_annot (str): the return type annotation (if one exists)
+        lines (str):
+            unindented lines from a Returns or Yields section
+
+        return_annot (str | None):
+            the return type annotation (if one exists)
 
     Yields:
         Dict[str, str]: each dict specifies the return type and its description
@@ -200,11 +443,22 @@ def finalize(retdict):
             yield finalize(retdict)
 
 
-def parse_google_argblock(lines):
+def parse_google_argblock(lines, clean_desc=True):
     r"""
+    Parse out individual items from google-style args blocks.
+
     Args:
         lines (str): the unindented lines from an Args docstring section
 
+        clean_desc (bool):
+            if True, will strip the description of newlines and indents.
+            Defaults to True.
+
+    Yields:
+        Dict[str, str | None]:
+            A dictionary containing keys, "name", "type", and "desc"
+            corresponding to an argument in the Args block.
+
     Example:
         >>> # Test various ways that arglines can be written
         >>> line_list = [
@@ -222,11 +476,20 @@ def parse_google_argblock(lines):
         ...     'attr1 (Optional[int]): Description of `attr1`.',
         ...     'attr2 (List[str]): Description of `attr2`.',
         ...     'attr3 (Dict[str, str]): Description of `attr3`.',
+        ...     '*args : variable positional args description',
+        ...     '**kwargs : keyword arguments description',
+        ...     'malformed and unparseable',
+        ...     'param_no_desc1',  # todo: this should be parseable
+        ...     'param_no_desc2:',
+        ...     'param_no_desc3 ()',  # todo: this should be parseable
+        ...     'param_no_desc4 ():',
+        ...     'param_no_desc5 (str)',  # todo: this should be parseable
+        ...     'param_no_desc6 (str):',
         ... ]
         >>> lines = '\n'.join(line_list)
         >>> argdict_list = list(parse_google_argblock(lines))
         >>> # All lines except the first should be accepted
-        >>> assert len(argdict_list) == len(line_list) - 1
+        >>> assert len(argdict_list) == len(line_list) - 5
         >>> assert argdict_list[1]['desc'] == 'a description with a newline'
     """
     def named(key, pattern):
@@ -239,8 +502,11 @@ def regex_or(patterns):
         return '({})'.format('|'.join(patterns))
     whitespace = r'\s*'
     endofstr = r'\Z'
+
     # Define characters that can be part of variable / type names
-    varname = named('name', '[A-Za-z_][A-Za-z0-9_]*')
+    # Note: a variable name might be prefixed with 0, 1, or 2, `*` to indicate
+    # *args or **kwargs
+    varname = named('name', r'\*?\*?[A-Za-z_][A-Za-z0-9_]*')
     typename = named('type', '[^)]*?')
     argdesc = named('desc', '.*?')
     # Types are optional, and must be enclosed in parens
@@ -257,229 +523,8 @@ def regex_or(patterns):
     for match in argline_pat.finditer(lines):
         argdict = match.groupdict()
         # Clean description
-        desc_lines = [p.strip() for p in argdict['desc'].split('\n')]
-        argdict['desc'] = ' '.join([p for p in desc_lines if p])
-        yield argdict
-
-
-def split_google_docblocks(docstr):
-    """ Breaks a docstring into parts defined by google style
-
-    Args:
-        docstr (str): a docstring
-
-    Returns:
-        List[Tuple]: list of 2-tuples where the first item is a google style
-            docstring tag and the second item is the bock corresponding to that
-            tag.
-
-    CommandLine:
-        xdoctest xdoctest.docstr.docscrape_google split_google_docblocks:2
-
-    Example:
-        >>> from xdoctest.docstr.docscrape_google import *  # NOQA
-        >>> from xdoctest import utils
-        >>> docstr = utils.codeblock(
-        ...     '''
-        ...     one line description
-        ...
-        ...     multiline
-        ...     description
-        ...
-        ...     Args:
-        ...         foo: bar
-        ...
-        ...     Returns:
-        ...         None
-        ...
-        ...     Example:
-        ...         >>> print('eg1')
-        ...         eg1
-        ...
-        ...     Example:
-        ...         >>> print('eg2')
-        ...         eg2
-        ...     ''')
-        >>> groups = split_google_docblocks(docstr)
-        >>> assert len(groups) == 5
-        >>> [g[0] for g in groups]
-        ['__DOC__', 'Args', 'Returns', 'Example', 'Example']
-
-    Example:
-        >>> from xdoctest.docstr.docscrape_google import *  # NOQA
-        >>> docstr = split_google_docblocks.__doc__
-        >>> groups = split_google_docblocks(docstr)
-
-    Example:
-        >>> from xdoctest.docstr.docscrape_google import *  # NOQA
-        >>> from xdoctest import utils
-        >>> docstr = utils.codeblock(
-        ...     '''
-        ...      a description with a leading space
-        ...
-        ...     Example:
-        ...         >>> foobar
-        ...     ''')
-        >>> groups = split_google_docblocks(docstr)
-        >>> print('groups = {!r}'.format(groups))
-
-    Example:
-        >>> from xdoctest.docstr.docscrape_google import *  # NOQA
-        >>> from xdoctest import utils
-        >>> docstr = utils.codeblock(
-        ...     '''
-        ...     Example:
-        ...         >>> foobar
-        ...     ''')
-        >>> # Check that line offsets are valid if the first line is not blank
-        >>> groups = split_google_docblocks(docstr)
-        >>> offset = groups[0][1][1]
-        >>> print('offset = {!r}'.format(offset))
-        >>> assert offset == 0
-        >>> # Check that line offsets are valid if the first line is blank
-        >>> groups = split_google_docblocks(chr(10) + docstr)
-        >>> offset = groups[0][1][1]
-        >>> print('offset = {!r}'.format(offset))
-        >>> assert offset == 1
-    """
-    if not isinstance(docstr, six.string_types):
-        raise TypeError('Input docstr must be a string. Got {} instead'.format(
-            type(docstr)))
-
-    def get_indentation(line_):
-        """ returns number of preceding spaces """
-        return len(line_) - len(line_.lstrip())
-
-    # Parse out initial documentation lines
-    # Then parse out the blocked lines.
-    docstr = ensure_unicode(docstr)
-
-    docstr = textwrap.dedent(docstr)
-    docstr_lines = docstr.split('\n')
-    line_indent = [get_indentation(line) for line in docstr_lines]
-    line_len = [len(line) for line in docstr_lines]
-
-    # The first line may not have the correct indentation if it starts
-    # right after the triple quotes. Adjust it in this case to ensure that
-    # base indent is always 0
-    adjusted = False
-    is_nonzero = [len_ > 0 for len_ in line_len]
-    if len(line_indent) >= 2:
-        if line_len[0] != 0:
-            indents = [x for x, f in zip(line_indent, is_nonzero) if f]
-            if len(indents) >= 2:
-                indent_adjust = min(indents[1:])
-                line_indent[0] += indent_adjust
-                line_len[0] += indent_adjust
-                docstr_lines[0] = (' ' * indent_adjust) + docstr_lines[0]
-                adjusted = True
-    if adjusted:
-        # Redo prepreocessing, but this time on a rectified input
-        docstr = textwrap.dedent('\n'.join(docstr_lines))
-        docstr_lines = docstr.split('\n')
-        line_indent = [get_indentation(line) for line in docstr_lines]
-        line_len = [len(line) for line in docstr_lines]
-
-    indents = [x for x, f in zip(line_indent, is_nonzero) if f]
-    if False and len(indents) >= 1:
-        if indents[0] != 0:
-            # debug info
-            print('INDENTATION ERROR IN PARSING DOCSTRING')
-            print('CHECK TO MAKE SURE YOU USED A RAW STRING IF YOU USE "\\n"')
-            # TODO: Report this error with line number and file information
-            print('Docstring:')
-            print('----------')
-            print(docstr)
-            print('----------')
-            raise exceptions.MalformedDocstr('malformed google docstr')
-
-    base_indent = 0
-    # We will group lines by their indentation.
-    # Rectify empty lines by giving them their parent's indentation.
-    true_indent = []
-    prev_indent = None
-    for indent_, len_ in zip(line_indent, line_len):
-        if len_ == 0:
-            # Empty lines take on their parents indentation
-            indent_ = prev_indent
-        true_indent.append(indent_)
-        prev_indent = indent_
-
-    # List of google style tags grouped by alias
-    tag_groups = [
-        ['Args', 'Arguments', 'Parameters', 'Other Parameters'],
-        ['Kwargs', 'Keyword Args', 'Keyword Arguments'],
-        ['Warns', 'Warning', 'Warnings'],
-        ['Returns', 'Return'],
-        ['Example', 'Examples'],
-        ['Doctest'],
-        ['Note', 'Notes'],
-        ['Yields', 'Yield'],
-        ['Attributes'],
-        ['Methods'],
-        ['Raises'],
-        ['References'],
-        ['See Also'],
-        ['Todo'],
-    ]
-    # Map aliased tags to a canonical name (the first item in the group).
-    tag_aliases = dict([(item, group[0]) for group in tag_groups for item in group])
-    # Allow for single or double colon (support for pytorch)
-    tag_pattern = '^' + '(' + '|'.join(tag_aliases.keys()) + ') *::? *$'
+        if clean_desc:
+            desc_lines = [p.strip() for p in argdict['desc'].split('\n')]
+            argdict['desc'] = ' '.join([p for p in desc_lines if p])
 
-    # Label lines by their group-id
-    group_id = 0
-    prev_indent = 0
-    group_list = []
-    in_tag = False
-    for line_num, (line, indent_) in enumerate(zip(docstr_lines, true_indent)):
-        if re.match(tag_pattern, line):
-            # Check if we can look ahead
-            if line_num + 1 < len(docstr_lines):
-                # A tag is only valid if its next line is properly indented,
-                # empty, or is a tag itself.
-                indent_increase = true_indent[line_num + 1] > base_indent
-                indent_zero = line_len[line_num + 1] == 0
-                matches_tag = re.match(tag_pattern, docstr_lines[line_num + 1])
-                if (indent_increase or indent_zero or matches_tag):
-                    group_id += 1
-                    in_tag = True
-            else:
-                group_id += 1
-                in_tag = True
-        # If the indentation goes back to the base, then we have left the tag
-        elif in_tag and indent_ != prev_indent and indent_ == base_indent:
-            group_id += 1
-            in_tag = False
-        group_list.append(group_id)
-        prev_indent = indent_
-
-    assert len(docstr_lines) == len(group_list)
-
-    # Group docstr lines by group list
-    groups_ = collections.defaultdict(list)
-    for groupid, line in zip(group_list, docstr_lines):
-        groups_[groupid].append(line)
-
-    groups = []
-    line_offset = 0
-    for k, lines in groups_.items():
-        if len(lines) == 0 or (len(lines) == 1 and len(lines[0]) == 0):
-            line_offset += len(lines)
-            continue
-        elif len(lines) >= 1 and re.match(tag_pattern, lines[0]):
-            # An encoded google sub-block
-            key = lines[0].strip().rstrip(':')
-            val = lines[1:]
-            subblock = textwrap.dedent('\n'.join(val))
-        else:
-            # A top level text documentation block
-            key = '__DOC__'
-            val = lines[:]
-            subblock = '\n'.join(val)
-
-        key = tag_aliases.get(key, key)
-        block = (subblock, line_offset)
-        groups.append((key, block))
-        line_offset += len(lines)
-    return groups
+        yield argdict

From 93527db487d923cc7e6dc5079e0eb68c243e9bb6 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 18:00:05 -0400
Subject: [PATCH 11/38] work on modernizing setup

---
 .github/workflows/tests.yml         | 494 ++++++++++++----------------
 .readthedocs.yml                    |  19 +-
 dev/setup_secrets.sh                | 275 +++++++++++++++-
 publish.sh                          | 289 +++++++++++-----
 run_doctests.sh                     |   2 +-
 run_tests.py                        |  16 +-
 setup.py                            | 228 ++++++-------
 xdoctest/docstr/docscrape_google.py |   2 +-
 8 files changed, 812 insertions(+), 513 deletions(-)

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index cd286651..9c33b588 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -1,7 +1,9 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+# Based on ~/code/xcookie/xcookie/rc/tests.yml.in
+# Now based on ~/code/xcookie/xcookie/builders/github_actions.py
 
-name: Tests
+name: PurePy Build and Test
 
 on:
   push:
@@ -9,228 +11,203 @@ on:
     branches: [ main ]
 
 jobs:
-
-  lint:
+  lint_job:
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout source
+      uses: actions/checkout@v3
     - name: Set up Python 3.8
       uses: actions/setup-python@v4
       with:
         python-version: 3.8
     - name: Install dependencies
-      run: |
+      run: |-
         python -m pip install --upgrade pip
         python -m pip install flake8
     - name: Lint with flake8
-      run: |
+      run: |-
         # stop the build if there are Python syntax errors or undefined names
         flake8 ./xdoctest --count --select=E9,F63,F7,F82 --show-source --statistics
-    #    # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-    #    flake8 . --count --exit-zero --max-complexity=20 --max-line-length=127 --statistics
-
+    - name: Typecheck with mypy
+      run: |-
+        python -m pip install mypy
+        mypy --install-types --non-interactive ./xdoctest
+        mypy ./xdoctest
   build_and_test_sdist:
     name: Test sdist Python 3.8
     runs-on: ubuntu-latest
-    #needs: [lint]
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout source
+      uses: actions/checkout@v3
     - name: Set up Python 3.8
       uses: actions/setup-python@v4
       with:
         python-version: 3.8
-    - name: Upgrade pip 
-      run: |
+    - name: Upgrade pip
+      run: |-
         python -m pip install --upgrade pip
         python -m pip install -r requirements/tests.txt
         python -m pip install -r requirements/runtime.txt
+        true
     - name: Build sdist
-      run: |
-        python setup.py sdist
+      shell: bash
+      run: |-
+        python -m pip install pip -U
+        python -m pip install setuptools>=0.8 wheel build
+        python -m build --sdist --outdir wheelhouse
     - name: Install sdist
-      run: |
-        ls -al ./dist
-        pip install dist/xdoctest*.tar.gz -v
-        mv xdoctest ignore_src_xdoctest
-    - name: Test minimal sdist
-      run: |
+      run: |-
+        ls -al ./wheelhouse
+        pip install wheelhouse/xdoctest*.tar.gz -v
+    - name: Test minimal loose sdist
+      run: |-
         pwd
         ls -al
-        # Run the tests
-        # Get path to installed package
-        XDOCTEST_DPATH=$(python -c "import xdoctest, os; print(os.path.dirname(xdoctest.__file__))")
-        echo "XDOCTEST_DPATH = $XDOCTEST_DPATH"
-        python -m pytest -p pytester -p no:doctest --xdoctest --cov=xdoctest $XDOCTEST_DPATH ./testing
-
-    - name: Test full sdist
-      run: |
+        MOD_DPATH=$(python -c "import xdoctest, os; print(os.path.dirname(xdoctest.__file__))")
+        echo "MOD_DPATH = $MOD_DPATH"
+        python -m pytest -p pytester -p no:doctest --xdoctest --cov=xdoctest $MOD_DPATH ./tests
+    - name: Test full loose sdist
+      run: |-
         pwd
         ls -al
         python -m pip install -r requirements/optional.txt
+        true
+        MOD_DPATH=$(python -c "import xdoctest, os; print(os.path.dirname(xdoctest.__file__))")
+        echo "MOD_DPATH = $MOD_DPATH"
+        # Run in a sandboxed directory
+        WORKSPACE_DNAME="testsrcdir_${CI_PYTHON_VERSION}_${GITHUB_RUN_ID}_${RUNNER_OS}"
+        mkdir -p $WORKSPACE_DNAME
+        cd $WORKSPACE_DNAME
         # Run the tests
         # Get path to installed package
-        XDOCTEST_DPATH=$(python -c "import xdoctest, os; print(os.path.dirname(xdoctest.__file__))")
-        echo "XDOCTEST_DPATH = $XDOCTEST_DPATH"
-        python -m pytest -p pytester -p no:doctest --xdoctest $XDOCTEST_DPATH ./testing
-
-
+        MOD_DPATH=$(python -c "import xdoctest, os; print(os.path.dirname(xdoctest.__file__))")
+        echo "MOD_DPATH = $MOD_DPATH"
+        python -m pytest -p pytester -p no:doctest --xdoctest $MOD_DPATH ../tests
+        cd ..
     - name: Upload sdist artifact
       uses: actions/upload-artifact@v3
       with:
         name: wheels
-        path: ./dist/*.tar.gz
-
-  build_and_test_wheels:
-    # TODO: handle different python versions: https://github.com/actions/setup-python
-    name: ${{ matrix.python-version }} ${{ matrix.requirement_mode }} on ${{ matrix.os }}, arch=${{ matrix.arch }}
+        path: ./wheelhouse/*.tar.gz
+  build_and_test_purepy_wheels:
+    name: ${{ matrix.python-version }} on ${{ matrix.os }}, arch=${{ matrix.arch }} with ${{ matrix.install-extras }}
     runs-on: ${{ matrix.os }}
-    #needs: [lint]
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macOS-latest]
-        requirement_mode: [strict, loose]
-        #requirement_mode: [strict]
-        python-version: 
-          - '2.7'
-          #- '3.4'  # 
-          - '3.5'
-          - '3.6'
-          - '3.7'
-          - '3.8'
-          - '3.9'
-          - '3.10'
-        # TODO: It is probably safe to not run the "strict" variant on all of the other matrix params. 
-        arch: [auto]
-        #cibw_build: [cp3*-*]
-        #cibw_skip: ["*-win32"]
-        # Add additional workers to reduce overall build time
-        #include:
-        #  - os: windows-latest
-        #    cibw_build: cp3*-win32
-        #    arch: auto
-        #    cibw_skip: ""
-        #  - os: ubuntu-latest
-        #    arch: aarch64
-        #    cibw_build: cp35-*
-        #  - os: ubuntu-latest
-        #    arch: aarch64
-        #    cibw_build: cp36-*
-        #  - os: ubuntu-latest
-        #    arch: aarch64
-        #    cibw_build: cp37-*
-        #  - os: ubuntu-latest
-        #    arch: aarch64
-        #    cibw_build: cp38-*
-        #  - os: ubuntu-latest
-        #    arch: aarch64
-        #    cibw_build: cp39-*
-
-
+        os:
+        - windows-latest
+        - ubuntu-latest
+        - macOS-latest
+        python-version:
+        - '2.7'
+        - '3.4'
+        - '3.5'
+        - '3.6'
+        - '3.7'
+        - '3.8'
+        - '3.9'
+        - '3.10'
+        - pypy-3.7
+        install-extras:
+        - tests
+        - tests,optional
+        arch:
+        - auto
+        include:
+        - python-version: '2.7'
+          os: windows-latest
+          install-extras: tests-strict,runtime-strict
+        - python-version: '3.10'
+          os: windows-latest
+          install-extras: tests-strict,runtime-strict
+        - python-version: '2.7'
+          os: windows-latest
+          install-extras: tests-strict,runtime-strict,optional-strict
+        - python-version: '3.10'
+          os: windows-latest
+          install-extras: tests-strict,runtime-strict,optional-strict
+        - python-version: '2.7'
+          os: ubuntu-latest
+          install-extras: tests-strict,runtime-strict
+        - python-version: '3.10'
+          os: ubuntu-latest
+          install-extras: tests-strict,runtime-strict
+        - python-version: '2.7'
+          os: ubuntu-latest
+          install-extras: tests-strict,runtime-strict,optional-strict
+        - python-version: '3.10'
+          os: ubuntu-latest
+          install-extras: tests-strict,runtime-strict,optional-strict
+        - python-version: '2.7'
+          os: macOS-latest
+          install-extras: tests-strict,runtime-strict
+        - python-version: '3.10'
+          os: macOS-latest
+          install-extras: tests-strict,runtime-strict
+        - python-version: '2.7'
+          os: macOS-latest
+          install-extras: tests-strict,runtime-strict,optional-strict
+        - python-version: '3.10'
+          os: macOS-latest
+          install-extras: tests-strict,runtime-strict,optional-strict
     steps:
     - name: Checkout source
       uses: actions/checkout@v3
-
-    # Configure compilers for Windows 64bit.
     - name: Enable MSVC 64bit
-      if: matrix.os == 'windows-latest' && matrix.cibw_build != 'cp3*-win32'
       uses: ilammy/msvc-dev-cmd@v1
-    
-    # Configure compilers for Windows 32bit.
+      if: matrix.os == 'windows-latest' && matrix.cibw_build != 'cp3*-win32'
     - name: Enable MSVC 32bit
-      if: matrix.os == 'windows-latest' && matrix.cibw_build == 'cp3*-win32'
       uses: ilammy/msvc-dev-cmd@v1
+      if: matrix.os == 'windows-latest' && matrix.cibw_build == 'cp3*-win32'
       with:
         arch: x86
-
-    # Emulate aarch64 ppc64le s390x under linux
     - name: Set up QEMU
-      if: runner.os == 'Linux' && matrix.arch != 'auto'
       uses: docker/setup-qemu-action@v2
+      if: runner.os == 'Linux' && matrix.arch != 'auto'
       with:
         platforms: all
-
-    # See: https://github.com/pypa/cibuildwheel/blob/main/action.yml
-    #- name: Build wheels
-    #  uses: pypa/cibuildwheel@v1.11.0
-    #  with:
-    #    output-dir: wheelhouse
-    #  # to supply options, put them in 'env', like:
-    #  env:
-    #    CIBW_SKIP: ${{ matrix.cibw_skip }}
-    #    CIBW_BUILD: ${{ matrix.cibw_build }}
-    #    CIBW_TEST_REQUIRES: -r requirements/tests.txt
-    #    CIBW_TEST_COMMAND: python {project}/run_tests.py
-    #    # configure cibuildwheel to build native archs ('auto'), or emulated ones
-    #    CIBW_ARCHS_LINUX: ${{ matrix.arch }}
-    
-    # Setup Python environemtn for a pure wheel
-    - uses: actions/setup-python@v4
+    - name: Setup Python
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    
     - name: Build pure wheel
       shell: bash
-      run: |
-        python -m pip install setuptools>=0.8 wheel
-        python -m pip wheel --no-deps --wheel-dir wheelhouse .
-
-    - name: Test pure wheel
+      run: |-
+        python -m pip install pip -U
+        python -m pip install setuptools>=0.8 build
+        python -m build --wheel --outdir wheelhouse
+    - name: Test wheel with ${{ matrix.install-extras }}
       shell: bash
       env:
+        INSTALL_EXTRAS: ${{ matrix.install-extras }}
         CI_PYTHON_VERSION: py${{ matrix.python-version }}
-        REQUIREMENT_MODE: ${{ matrix.requirement_mode }}
-        #OS_NAME: ${{ matrix.os }}
-      run: | 
-        # Remove source directory (ensure it doesn't conflict)
-        mv xdoctest ignore_src_xdoctest
-        rm pytest.ini
-        # Get the most recent wheel that matches the pattern
-        pwd
-        ls -al
-        ls -altr wheelhouse
-        WHEEL_FPATH=$(ls -t wheelhouse/xdoctest*.whl| head -n1)
-        echo "WHEEL_FPATH = $WHEEL_FPATH"
-        if [[ "${REQUIREMENT_MODE}" == "strict" ]]; then 
-          # Install the wheel with strict requirements
-          source dev/make_strict_req.sh
-          pip install -r requirements-strict/runtime.txt
-          pip install -r requirements-strict/tests.txt
-          python -m pip install ${WHEEL_FPATH}
-        elif [[ "${REQUIREMENT_MODE}" == "loose" ]]; then 
-          # Install the wheel with loose requirements
-          python -m pip install ${WHEEL_FPATH}[tests]
-          #python -m pip install -r requirements/tests.txt
-        else
-          echo "UNKNOWN REQUIREMENT MODE"
-          false
-        fi
-        # Run in a sandboxed directory
+      run: |-
+        # Find the path to the wheel
+        WHEEL_FPATH=$(ls wheelhouse/xdoctest*.whl)
+        # Install the wheel
+        python -m pip install ${WHEEL_FPATH}[${INSTALL_EXTRAS}]
+        # Create a sandboxed directory
         WORKSPACE_DNAME="testdir_${CI_PYTHON_VERSION}_${GITHUB_RUN_ID}_${RUNNER_OS}"
         mkdir -p $WORKSPACE_DNAME
         cd $WORKSPACE_DNAME
-        # Run the tests
-        # Get path to installed package
-        XDOCTEST_DPATH=$(python -c "import xdoctest, os; print(os.path.dirname(xdoctest.__file__))")
-        echo "XDOCTEST_DPATH = $XDOCTEST_DPATH"
-        python -m pytest -p pytester -p no:doctest --xdoctest --cov-config ../.coveragerc --cov-report term --cov=xdoctest $XDOCTEST_DPATH ../testing
+        # Get the path to the installed package and run the tests
+        MOD_DPATH=$(python -c "import xdoctest, os; print(os.path.dirname(xdoctest.__file__))")
+        echo "MOD_DPATH = $MOD_DPATH"
+        python -m pytest -p pytester -p no:doctest --xdoctest --cov-config ../pyproject.toml --cov-report term --cov=xdoctest $MOD_DPATH ../tests
+        # Move coverage file to a new name
         mv .coverage "../.coverage.$WORKSPACE_DNAME"
         cd ..
-        # Move coverage file to a new name
-
     - name: Show built files
       shell: bash
       run: ls -la wheelhouse
-
     - name: Set up Python 3.8 to combine coverage Linux
-      if: runner.os == 'Linux'
       uses: actions/setup-python@v4
+      if: runner.os == 'Linux'
       with:
         python-version: 3.8
-
     - name: Combine coverage Linux
       if: runner.os == 'Linux'
-      run: |
+      run: |-
         echo '############ PWD'
         pwd
         ls -al
@@ -242,147 +219,114 @@ jobs:
         echo '############ FIND'
         find . -name .coverage.*
         find . -name coverage.xml
-
-    - name: Codecov Upload
-      uses: codecov/codecov-action@v3
+    - uses: codecov/codecov-action@v3
+      name: Codecov Upload
       with:
         file: ./tests/coverage.xml
-
-    - name: Upload wheels artifact
-      uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v3
+      name: Upload wheels artifact
       with:
         name: wheels
         path: ./wheelhouse/xdoctest*.whl
-
-  deploy:
-    # Publish on the real PyPI
-    name: Uploading to PyPi
+  test_deploy:
+    name: Uploading Test to PyPi
     runs-on: ubuntu-latest
-    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
-    needs: [build_and_test_wheels, build_and_test_sdist]
+    if: github.event_name == 'push' && ! startsWith(github.event.ref, 'refs/tags') && ! startsWith(github.event.ref, 'refs/heads/release')
+    needs:
+    - build_and_test_sdist
+    - build_and_test_purepy_wheels
     steps:
-      - name: Checkout source
-        uses: actions/checkout@v3
-
-      - name: Download wheels and sdist
-        uses: actions/download-artifact@v3
-        with:
-          name: wheels
-          path: dist
-
-      - name: Show files to upload
-        shell: bash
-        run: ls -la dist
-
-      # Note:
-      # See ../../dev/setup_secrets.sh for details on how secrets are deployed securely
-      - name: Sign and Publish
-        env:
-          TWINE_REPOSITORY_URL: https://upload.pypi.org/legacy/
-          TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
-          EROTEMIC_CI_SECRET: ${{ secrets.EROTEMIC_CI_SECRET }}
-        run: |
-          ls -al
-          GPG_EXECUTABLE=gpg
-          $GPG_EXECUTABLE --version
-          openssl version
-          $GPG_EXECUTABLE --list-keys
-          echo "Decrypting Keys"
-          GLKWS=$EROTEMIC_CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/ci_public_gpg_key.pgp.enc | $GPG_EXECUTABLE --import 
-          GLKWS=$EROTEMIC_CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/gpg_owner_trust.enc | $GPG_EXECUTABLE --import-ownertrust
-          GLKWS=$EROTEMIC_CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/ci_secret_gpg_subkeys.pgp.enc | $GPG_EXECUTABLE --import
-          echo "Finish Decrypt Keys"
-          $GPG_EXECUTABLE --list-keys  || echo "first invocation of gpg creates directories and returns 1"
-          $GPG_EXECUTABLE --list-keys  
-          MB_PYTHON_TAG=$(python -c "import setup; print(setup.MB_PYTHON_TAG)")
-          VERSION=$(python -c "import setup; print(setup.VERSION)") 
-          pip install twine
-          pip install six pyopenssl ndg-httpsclient pyasn1 -U --user
-          pip install requests[security] twine --user
-          GPG_KEYID=$(cat dev/public_gpg_key)
-          echo "GPG_KEYID = '$GPG_KEYID'"
-          MB_PYTHON_TAG=$MB_PYTHON_TAG \
-              DO_GPG=True GPG_KEYID=$GPG_KEYID \
-              TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL} \
-              TWINE_PASSWORD=$TWINE_PASSWORD \
-              TWINE_USERNAME=$TWINE_USERNAME \
-              GPG_EXECUTABLE=$GPG_EXECUTABLE \
-              DO_UPLOAD=True \
-              DO_BUILD=False \
-              DO_TAG=False ./publish.sh 
-
-  test_deploy:
-    # Publish on the test PyPI
-    name: Uploading to Test PyPi
+    - name: Checkout source
+      uses: actions/checkout@v3
+    - uses: actions/download-artifact@v3
+      name: Download wheels and sdist
+      with:
+        name: wheels
+        path: wheelhouse
+    - name: Show files to upload
+      shell: bash
+      run: ls -la wheelhouse
+    - name: Sign and Publish
+      env:
+        TWINE_REPOSITORY_URL: https://test.pypi.org/legacy/
+        TWINE_USERNAME: ${{ secrets.TEST_TWINE_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.TEST_TWINE_PASSWORD }}
+        CI_SECRET: ${{ secrets.EROTEMIC_CI_SECRET }}
+      run: |-
+        GPG_EXECUTABLE=gpg
+        $GPG_EXECUTABLE --version
+        openssl version
+        $GPG_EXECUTABLE --list-keys
+        echo "Decrypting Keys"
+        CIS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CIS -d -a -in dev/ci_public_gpg_key.pgp.enc | $GPG_EXECUTABLE --import
+        CIS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CIS -d -a -in dev/gpg_owner_trust.enc | $GPG_EXECUTABLE --import-ownertrust
+        CIS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CIS -d -a -in dev/ci_secret_gpg_subkeys.pgp.enc | $GPG_EXECUTABLE --import
+        echo "Finish Decrypt Keys"
+        $GPG_EXECUTABLE --list-keys || true
+        $GPG_EXECUTABLE --list-keys  || echo "first invocation of gpg creates directories and returns 1"
+        $GPG_EXECUTABLE --list-keys
+        VERSION=$(python -c "import setup; print(setup.VERSION)")
+        pip install twine
+        pip install six pyopenssl ndg-httpsclient pyasn1 -U --user
+        pip install requests[security] twine --user
+        GPG_KEYID=$(cat dev/public_gpg_key)
+        echo "GPG_KEYID = '$GPG_KEYID'"
+        DO_GPG=True GPG_KEYID=$GPG_KEYID TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL} TWINE_PASSWORD=$TWINE_PASSWORD TWINE_USERNAME=$TWINE_USERNAME GPG_EXECUTABLE=$GPG_EXECUTABLE DO_UPLOAD=True DO_TAG=False ./publish.sh
+  live_deploy:
+    name: Uploading Live to PyPi
     runs-on: ubuntu-latest
-    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/heads/main') 
-    #if: github.event_name == 'push'
-    #&& !startsWith(github.event.ref, 'refs/tags')
-    needs: [build_and_test_wheels, build_and_test_sdist]
+    if: github.event_name == 'push' && (startsWith(github.event.ref, 'refs/tags') || startsWith(github.event.ref, 'refs/heads/release'))
+    needs:
+    - build_and_test_sdist
+    - build_and_test_purepy_wheels
     steps:
-      - name: Checkout source
-        uses: actions/checkout@v3
-
-      - name: Download wheels and sdist
-        uses: actions/download-artifact@v3
-        with:
-          name: wheels
-          path: dist
-
-      - name: Show files to upload
-        shell: bash
-        run: ls -la dist
-      - name: Sign and Publish
-        env:
-          TEST_TWINE_REPOSITORY_URL: https://test.pypi.org/legacy/
-          TEST_TWINE_USERNAME: ${{ secrets.TEST_TWINE_USERNAME }}
-          TEST_TWINE_PASSWORD: ${{ secrets.TEST_TWINE_PASSWORD }}
-          EROTEMIC_CI_SECRET: ${{ secrets.EROTEMIC_CI_SECRET }}
-        run: |
-          ls -al
-          GPG_EXECUTABLE=gpg
-          $GPG_EXECUTABLE --version
-          openssl version
-          $GPG_EXECUTABLE --list-keys || true
-          echo "Decrypting Keys"
-          GLKWS=$EROTEMIC_CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/ci_public_gpg_key.pgp.enc | $GPG_EXECUTABLE --import 
-          GLKWS=$EROTEMIC_CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/gpg_owner_trust.enc | $GPG_EXECUTABLE --import-ownertrust
-          GLKWS=$EROTEMIC_CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/ci_secret_gpg_subkeys.pgp.enc | $GPG_EXECUTABLE --import
-          echo "Finish Decrypt Keys"
-          $GPG_EXECUTABLE --list-keys  || echo "first invocation of gpg creates directories and returns 1"
-          $GPG_EXECUTABLE --list-keys  
-          MB_PYTHON_TAG=$(python -c "import setup; print(setup.MB_PYTHON_TAG)")
-          VERSION=$(python -c "import setup; print(setup.VERSION)") 
-          pip install twine
-          pip install six pyopenssl ndg-httpsclient pyasn1 -U --user
-          pip install requests[security] twine --user
-          GPG_KEYID=$(cat dev/public_gpg_key)
-          echo "GPG_KEYID = '$GPG_KEYID'"
-          MB_PYTHON_TAG=$MB_PYTHON_TAG \
-              DO_GPG=True GPG_KEYID=$GPG_KEYID \
-              TWINE_REPOSITORY_URL=${TEST_TWINE_REPOSITORY_URL} \
-              TWINE_USERNAME=${TEST_TWINE_USERNAME} \
-              TWINE_PASSWORD=${TEST_TWINE_PASSWORD} \
-              GPG_EXECUTABLE=$GPG_EXECUTABLE \
-              DO_UPLOAD=True \
-              DO_BUILD=False \
-              DO_TAG=False ./publish.sh
+    - name: Checkout source
+      uses: actions/checkout@v3
+    - uses: actions/download-artifact@v3
+      name: Download wheels and sdist
+      with:
+        name: wheels
+        path: wheelhouse
+    - name: Show files to upload
+      shell: bash
+      run: ls -la wheelhouse
+    - name: Sign and Publish
+      env:
+        TWINE_REPOSITORY_URL: https://upload.pypi.org/legacy/
+        TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+        CI_SECRET: ${{ secrets.EROTEMIC_CI_SECRET }}
+      run: |-
+        GPG_EXECUTABLE=gpg
+        $GPG_EXECUTABLE --version
+        openssl version
+        $GPG_EXECUTABLE --list-keys
+        echo "Decrypting Keys"
+        CIS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CIS -d -a -in dev/ci_public_gpg_key.pgp.enc | $GPG_EXECUTABLE --import
+        CIS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CIS -d -a -in dev/gpg_owner_trust.enc | $GPG_EXECUTABLE --import-ownertrust
+        CIS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:CIS -d -a -in dev/ci_secret_gpg_subkeys.pgp.enc | $GPG_EXECUTABLE --import
+        echo "Finish Decrypt Keys"
+        $GPG_EXECUTABLE --list-keys || true
+        $GPG_EXECUTABLE --list-keys  || echo "first invocation of gpg creates directories and returns 1"
+        $GPG_EXECUTABLE --list-keys
+        VERSION=$(python -c "import setup; print(setup.VERSION)")
+        pip install twine
+        pip install six pyopenssl ndg-httpsclient pyasn1 -U --user
+        pip install requests[security] twine --user
+        GPG_KEYID=$(cat dev/public_gpg_key)
+        echo "GPG_KEYID = '$GPG_KEYID'"
+        DO_GPG=True GPG_KEYID=$GPG_KEYID TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL} TWINE_PASSWORD=$TWINE_PASSWORD TWINE_USERNAME=$TWINE_USERNAME GPG_EXECUTABLE=$GPG_EXECUTABLE DO_UPLOAD=True DO_TAG=False ./publish.sh
 
-       
 ###
 # Unfortunately we cant (yet) use the yaml docstring trick here
 # https://github.community/t/allow-unused-keys-in-workflow-yaml-files/172120
 #__doc__: |
 #    # How to run locally
 #    # https://packaging.python.org/guides/using-testpypi/
-#    cd $HOME/code
 #    git clone https://github.com/nektos/act.git $HOME/code/act
-#    cd $HOME/code/act
-#    chmod +x install.sh
-#    ./install.sh -b $HOME/.local/opt/act
-#    cd $HOME/code/xdoctest
-
+#    chmod +x $HOME/code/act/install.sh
+#    (cd $HOME/code/act && ./install.sh -b $HOME/.local/opt/act)
+#
 #    load_secrets
 #    unset GITHUB_TOKEN
 #    $HOME/.local/opt/act/act \
@@ -390,4 +334,4 @@ jobs:
 #        --secret=EROTEMIC_TWINE_USERNAME=$EROTEMIC_TWINE_USERNAME \
 #        --secret=EROTEMIC_CI_SECRET=$EROTEMIC_CI_SECRET \
 #        --secret=EROTEMIC_TEST_TWINE_USERNAME=$EROTEMIC_TEST_TWINE_USERNAME \
-#        --secret=EROTEMIC_TEST_TWINE_PASSWORD=$EROTEMIC_TEST_TWINE_PASSWORD 
+#        --secret=EROTEMIC_TEST_TWINE_PASSWORD=$EROTEMIC_TEST_TWINE_PASSWORD
diff --git a/.readthedocs.yml b/.readthedocs.yml
index c7b9eb75..8a1cff88 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -1,11 +1,9 @@
 # .readthedocs.yml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-# See also: https://readthedocs.org/dashboard/xdoctest/advanced/
-
-
-# TODO:
-# is there a config setting here that enables building on PRs?
+# 
+# See Also:
+# https://readthedocs.org/dashboard/xdoctest/advanced/
 
 # Required
 version: 2
@@ -14,6 +12,10 @@ version: 2
 sphinx:
   configuration: docs/source/conf.py
 
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: all
 
@@ -21,6 +23,11 @@ formats: all
 python:
   version: 3.7
   install:
-    - requirements: docs/requirements.txt
+    - requirements: requirements/docs.txt
     - method: pip
       path: .
+      #extra_requirements:
+      #  - docs
+
+#conda:
+#  environment: environment.yml
diff --git a/dev/setup_secrets.sh b/dev/setup_secrets.sh
index ddda23a7..a4ba167a 100644
--- a/dev/setup_secrets.sh
+++ b/dev/setup_secrets.sh
@@ -1,3 +1,4 @@
+#!/bin/bash
 __doc__='
 ============================
 SETUP CI SECRET INSTRUCTIONS
@@ -7,7 +8,7 @@ TODO: These instructions are currently pieced together from old disparate
 instances, and are not yet fully organized.
 
 The original template file should be:
-~/misc/templates/PYPKG/dev/setup_secrets.sh
+~/code/xcookie/dev/setup_secrets.sh
 
 Development script for updating secrets when they rotate
 
@@ -38,7 +39,7 @@ GITLAB ACTION INSTRUCTIONS
     ```bash
     cat .setup_secrets.sh | \
         sed "s|utils|<YOUR-GROUP>|g" | \
-        sed "s|PYPKG|<YOUR-REPO>|g" | \
+        sed "s|xcookie|<YOUR-REPO>|g" | \
         sed "s|travis-ci-Erotemic|<YOUR-GPG-ID>|g" | \
         sed "s|CI_SECRET|<YOUR_CI_SECRET>|g" | \
         sed "s|GITLAB_ORG_PUSH_TOKEN|<YOUR_GIT_ORG_PUSH_TOKEN>|g" | \
@@ -47,12 +48,12 @@ GITLAB ACTION INSTRUCTIONS
     ```
 
     * Make sure you add Runners to your project 
-    https://gitlab.org.com/utils/PYPKG/-/settings/ci_cd 
+    https://gitlab.org.com/utils/xcookie/-/settings/ci_cd 
     in Runners-> Shared Runners
     and Runners-> Available specific runners
 
     * Ensure that you are auto-cancel redundant pipelines.
-    Navigate to https://gitlab.kitware.com/utils/PYPKGS/-/settings/ci_cd and ensure "Auto-cancel redundant pipelines" is checked.
+    Navigate to https://gitlab.kitware.com/utils/xcookie/-/settings/ci_cd and ensure "Auto-cancel redundant pipelines" is checked.
 
     More details are here https://docs.gitlab.com/ee/ci/pipelines/settings.html#auto-cancel-redundant-pipelines
 
@@ -107,7 +108,6 @@ https://github.com/pyutils/line_profiler/settings/secrets/actions
 https://app.circleci.com/settings/project/github/pyutils/line_profiler/environment-variables?return-to=https%3A%2F%2Fapp.circleci.com%2Fpipelines%2Fgithub%2Fpyutils%2Fline_profiler
 '
 
-
 setup_package_environs(){
     __doc__="
     Setup environment variables specific for this project.
@@ -115,11 +115,46 @@ setup_package_environs(){
     non-secret variables are written to disk and loaded by the script, such
     that the specific repo only needs to modify that configuration file.
     "
+    echo "Choose an organization specific setting or make your own. This needs to be generalized more"
+}
+
+### FIXME: Should be configurable for general use
+
+setup_package_environs_gitlab_kitware(){
+    echo '
+    export VARNAME_CI_SECRET="CI_KITWARE_SECRET"
+    export VARNAME_TWINE_PASSWORD="EROTEMIC_PYPI_MASTER_TOKEN"
+    export VARNAME_TEST_TWINE_PASSWORD="EROTEMIC_TEST_PYPI_MASTER_TOKEN"
+    export VARNAME_PUSH_TOKEN="GITLAB_KITWARE_TOKEN"
+    export VARNAME_TWINE_USERNAME="EROTEMIC_PYPI_MASTER_TOKEN_USERNAME"
+    export VARNAME_TEST_TWINE_USERNAME="EROTEMIC_TEST_PYPI_MASTER_TOKEN_USERNAME"
+    export GPG_IDENTIFIER="=Erotemic-CI <erotemic@gmail.com>"
+    ' | python -c "import sys; from textwrap import dedent; print(dedent(sys.stdin.read()).strip(chr(10)))" > dev/secrets_configuration.sh
+    git add dev/secrets_configuration.sh
+}
 
+setup_package_environs_github_erotemic(){
     echo '
     export VARNAME_CI_SECRET="EROTEMIC_CI_SECRET"
+    export VARNAME_TWINE_PASSWORD="EROTEMIC_PYPI_MASTER_TOKEN"
+    export VARNAME_TEST_TWINE_PASSWORD="EROTEMIC_TEST_PYPI_MASTER_TOKEN"
+    export VARNAME_TWINE_USERNAME="EROTEMIC_PYPI_MASTER_TOKEN_USERNAME"
+    export VARNAME_TEST_TWINE_USERNAME="EROTEMIC_TEST_PYPI_MASTER_TOKEN_USERNAME"
     export GPG_IDENTIFIER="=Erotemic-CI <erotemic@gmail.com>"
     ' | python -c "import sys; from textwrap import dedent; print(dedent(sys.stdin.read()).strip(chr(10)))" > dev/secrets_configuration.sh
+    git add dev/secrets_configuration.sh
+}
+
+setup_package_environs_github_pyutils(){
+    echo '
+    export VARNAME_CI_SECRET="PYUTILS_CI_SECRET"
+    export VARNAME_TWINE_PASSWORD="PYUTILS_PYPI_MASTER_TOKEN"
+    export VARNAME_TEST_TWINE_PASSWORD="PYUTILS_TEST_PYPI_MASTER_TOKEN"
+    export VARNAME_TWINE_USERNAME="PYUTILS_PYPI_MASTER_TOKEN_USERNAME"
+    export VARNAME_TEST_TWINE_USERNAME="PYUTILS_TEST_PYPI_MASTER_TOKEN_USERNAME"
+    export GPG_IDENTIFIER="=PyUtils-CI <openpyutils@gmail.com>"
+    ' | python -c "import sys; from textwrap import dedent; print(dedent(sys.stdin.read()).strip(chr(10)))" > dev/secrets_configuration.sh
+    git add dev/secrets_configuration.sh
 
     #echo '
     #export VARNAME_CI_SECRET="PYUTILS_CI_SECRET"
@@ -127,6 +162,217 @@ setup_package_environs(){
     #' | python -c "import sys; from textwrap import dedent; print(dedent(sys.stdin.read()).strip(chr(10)))" > dev/secrets_configuration.sh
 }
 
+upload_github_secrets(){
+    load_secrets
+    unset GITHUB_TOKEN
+    #printf "%s" "$GITHUB_TOKEN" | gh auth login --hostname Github.com --with-token 
+    gh auth login 
+    source dev/secrets_configuration.sh
+    gh secret set "$VARNAME_TWINE_USERNAME" -b"__token__"
+    gh secret set "$VARNAME_TEST_TWINE_USERNAME" -b"__token__"
+    toggle_setx_enter
+    gh secret set "$VARNAME_CI_SECRET" -b"${!VARNAME_CI_SECRET}"
+    gh secret set "$VARNAME_TWINE_PASSWORD" -b"${!VARNAME_TWINE_PASSWORD}"
+    gh secret set "$VARNAME_TEST_TWINE_PASSWORD" -b"${!VARNAME_TEST_TWINE_PASSWORD}"
+    toggle_setx_exit
+}
+
+
+toggle_setx_enter(){
+    # Can we do something like a try/finally?
+    # https://stackoverflow.com/questions/15656492/writing-try-catch-finally-in-shell
+    echo "Enter sensitive area"
+    if [[ -n "${-//[^x]/}" ]]; then
+        __context_1_toggle_setx=1
+    else
+        __context_1_toggle_setx=0
+    fi
+    if [[ "$__context_1_toggle_setx" == "1" ]]; then
+        echo "Setx was on, disable temporarilly"
+        set +x
+    fi
+}
+
+toggle_setx_exit(){
+    echo "Exit sensitive area"
+    # Can we guarentee this will happen?
+    if [[ "$__context_1_toggle_setx" == "1" ]]; then
+        set -x
+    fi
+}
+
+
+upload_gitlab_group_secrets(){
+    __doc__="
+    Use the gitlab API to modify group-level secrets
+    "
+    # In Repo Directory
+    load_secrets
+    REMOTE=origin
+    GROUP_NAME=$(git remote get-url $REMOTE | cut -d ":" -f 2 | cut -d "/" -f 1)
+    HOST=https://$(git remote get-url $REMOTE | cut -d "/" -f 1 | cut -d "@" -f 2 | cut -d ":" -f 1)
+    echo "
+    * GROUP_NAME = $GROUP_NAME
+    * HOST = $HOST
+    "
+    PRIVATE_GITLAB_TOKEN=$(git_token_for "$HOST")
+    if [[ "$PRIVATE_GITLAB_TOKEN" == "ERROR" ]]; then
+        echo "Failed to load authentication key"
+        return 1
+    fi
+
+    TMP_DIR=$(mktemp -d -t ci-XXXXXXXXXX)
+    curl --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/groups" > "$TMP_DIR/all_group_info"
+    GROUP_ID=$(cat "$TMP_DIR/all_group_info" | jq ". | map(select(.path==\"$GROUP_NAME\")) | .[0].id")
+    echo "GROUP_ID = $GROUP_ID"
+
+    curl --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/groups/$GROUP_ID" > "$TMP_DIR/group_info"
+    cat "$TMP_DIR/group_info" | jq
+
+    # Get group-level secret variables
+    curl --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/groups/$GROUP_ID/variables" > "$TMP_DIR/group_vars"
+    cat "$TMP_DIR/group_vars" | jq '.[] | .key'
+
+    if [[ "$?" != "0" ]]; then
+        echo "Failed to access group level variables. Probably a permission issue"
+    fi
+
+    source dev/secrets_configuration.sh
+    SECRET_VARNAME_ARR=(VARNAME_CI_SECRET VARNAME_TWINE_PASSWORD VARNAME_TEST_TWINE_PASSWORD VARNAME_PUSH_TOKEN)
+    for SECRET_VARNAME_PTR in "${SECRET_VARNAME_ARR[@]}"; do
+        SECRET_VARNAME=${!SECRET_VARNAME_PTR}
+        echo ""
+        echo " ---- "
+        LOCAL_VALUE=${!SECRET_VARNAME}
+        REMOTE_VALUE=$(cat "$TMP_DIR/group_vars" | jq -r ".[] | select(.key==\"$SECRET_VARNAME\") | .value")
+
+        # Print current local and remote value of a variable
+        echo "SECRET_VARNAME_PTR = $SECRET_VARNAME_PTR"
+        echo "SECRET_VARNAME = $SECRET_VARNAME"
+        echo "(local)  $SECRET_VARNAME = $LOCAL_VALUE"
+        echo "(remote) $SECRET_VARNAME = $REMOTE_VALUE"
+
+        #curl --request GET --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/groups/$GROUP_ID/variables/SECRET_VARNAME" | jq -r .message
+        if [[ "$REMOTE_VALUE" == "" ]]; then
+            # New variable
+            echo "Remove variable does not exist, posting"
+
+            toggle_setx_enter
+            curl --request POST --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/groups/$GROUP_ID/variables" \
+                    --form "key=${SECRET_VARNAME}" \
+                    --form "value=${LOCAL_VALUE}" \
+                    --form "protected=true" \
+                    --form "masked=true" \
+                    --form "environment_scope=*" \
+                    --form "variable_type=env_var" 
+            toggle_setx_exit
+        elif [[ "$REMOTE_VALUE" != "$LOCAL_VALUE" ]]; then
+            echo "Remove variable does not agree, putting"
+            # Update variable value
+            toggle_setx_enter
+            curl --request PUT --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/groups/$GROUP_ID/variables/$SECRET_VARNAME" \
+                    --form "value=${LOCAL_VALUE}" 
+            toggle_setx_exit
+        else
+            echo "Remote value agrees with local"
+        fi
+    done
+    rm "$TMP_DIR/group_vars"
+}
+
+upload_gitlab_repo_secrets(){
+    __doc__="
+    Use the gitlab API to modify group-level secrets
+    "
+    # In Repo Directory
+    load_secrets
+    REMOTE=origin
+    GROUP_NAME=$(git remote get-url $REMOTE | cut -d ":" -f 2 | cut -d "/" -f 1)
+    PROJECT_NAME=$(git remote get-url $REMOTE | cut -d ":" -f 2 | cut -d "/" -f 2 | cut -d "." -f 1)
+    HOST=https://$(git remote get-url $REMOTE | cut -d "/" -f 1 | cut -d "@" -f 2 | cut -d ":" -f 1)
+    echo "
+    * GROUP_NAME = $GROUP_NAME
+    * PROJECT_NAME = $PROJECT_NAME
+    * HOST = $HOST
+    "
+    PRIVATE_GITLAB_TOKEN=$(git_token_for "$HOST")
+    if [[ "$PRIVATE_GITLAB_TOKEN" == "ERROR" ]]; then
+        echo "Failed to load authentication key"
+        return 1
+    fi
+
+    TMP_DIR=$(mktemp -d -t ci-XXXXXXXXXX)
+    toggle_setx_enter
+    curl --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/groups" > "$TMP_DIR/all_group_info"
+    toggle_setx_exit
+    GROUP_ID=$(cat "$TMP_DIR/all_group_info" | jq ". | map(select(.path==\"$GROUP_NAME\")) | .[0].id")
+    echo "GROUP_ID = $GROUP_ID"
+
+    toggle_setx_enter
+    curl --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/groups/$GROUP_ID" > "$TMP_DIR/group_info"
+    toggle_setx_exit
+    GROUP_ID=$(cat "$TMP_DIR/all_group_info" | jq ". | map(select(.path==\"$GROUP_NAME\")) | .[0].id")
+    cat "$TMP_DIR/group_info" | jq
+
+    PROJECT_ID=$(cat "$TMP_DIR/group_info" | jq ".projects | map(select(.path==\"$PROJECT_NAME\")) | .[0].id")
+    echo "PROJECT_ID = $PROJECT_ID"
+
+    # Get group-level secret variables
+    toggle_setx_enter
+    curl --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/projects/$PROJECT_ID/variables" > "$TMP_DIR/project_vars"
+    toggle_setx_exit
+    cat "$TMP_DIR/project_vars" | jq '.[] | .key'
+    if [[ "$?" != "0" ]]; then
+        echo "Failed to access project level variables. Probably a permission issue"
+    fi
+
+    LIVE_MODE=1
+    source dev/secrets_configuration.sh
+    SECRET_VARNAME_ARR=(VARNAME_CI_SECRET VARNAME_TWINE_PASSWORD VARNAME_TEST_TWINE_PASSWORD VARNAME_TWINE_USERNAME VARNAME_TEST_TWINE_USERNAME VARNAME_PUSH_TOKEN)
+    for SECRET_VARNAME_PTR in "${SECRET_VARNAME_ARR[@]}"; do
+        SECRET_VARNAME=${!SECRET_VARNAME_PTR}
+        echo ""
+        echo " ---- "
+        LOCAL_VALUE=${!SECRET_VARNAME}
+        REMOTE_VALUE=$(cat "$TMP_DIR/project_vars" | jq -r ".[] | select(.key==\"$SECRET_VARNAME\") | .value")
+
+        # Print current local and remote value of a variable
+        echo "SECRET_VARNAME_PTR = $SECRET_VARNAME_PTR"
+        echo "SECRET_VARNAME = $SECRET_VARNAME"
+        echo "(local)  $SECRET_VARNAME = $LOCAL_VALUE"
+        echo "(remote) $SECRET_VARNAME = $REMOTE_VALUE"
+
+        #curl --request GET --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/projects/$PROJECT_ID/variables/SECRET_VARNAME" | jq -r .message
+        if [[ "$REMOTE_VALUE" == "" ]]; then
+            # New variable
+            echo "Remove variable does not exist, posting"
+            if [[ "$LIVE_MODE" == "1" ]]; then
+                curl --request POST --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/projects/$PROJECT_ID/variables" \
+                        --form "key=${SECRET_VARNAME}" \
+                        --form "value=${LOCAL_VALUE}" \
+                        --form "protected=true" \
+                        --form "masked=true" \
+                        --form "environment_scope=*" \
+                        --form "variable_type=env_var" 
+            else
+                echo "dry run, not posting"
+            fi
+        elif [[ "$REMOTE_VALUE" != "$LOCAL_VALUE" ]]; then
+            echo "Remove variable does not agree, putting"
+            # Update variable value
+            if [[ "$LIVE_MODE" == "1" ]]; then
+                curl --request PUT --header "PRIVATE-TOKEN: $PRIVATE_GITLAB_TOKEN" "$HOST/api/v4/projects/$PROJECT_ID/variables/$SECRET_VARNAME" \
+                        --form "value=${LOCAL_VALUE}" 
+            else
+                echo "dry run, not putting"
+            fi
+        else
+            echo "Remote value agrees with local"
+        fi
+    done
+    rm "$TMP_DIR/project_vars"
+}
+
 
 export_encrypted_code_signing_keys(){
     # You will need to rerun this whenever the signkeys expire and are renewed
@@ -137,11 +383,11 @@ export_encrypted_code_signing_keys(){
     source dev/secrets_configuration.sh
 
     CI_SECRET="${!VARNAME_CI_SECRET}"
+    echo "VARNAME_CI_SECRET = $VARNAME_CI_SECRET"
     echo "CI_SECRET=$CI_SECRET"
     echo "GPG_IDENTIFIER=$GPG_IDENTIFIER"
 
     # ADD RELEVANT VARIABLES TO THE CI SECRET VARIABLES
-
     # HOW TO ENCRYPT YOUR SECRET GPG KEY
     # You need to have a known public gpg key for this to make any sense
 
@@ -154,19 +400,19 @@ export_encrypted_code_signing_keys(){
     # Export plaintext gpg public keys, private sign key, and trust info
     mkdir -p dev
     gpg --armor --export-options export-backup --export-secret-subkeys "${GPG_SIGN_SUBKEY}!" > dev/ci_secret_gpg_subkeys.pgp
-    gpg --armor --export ${GPG_SIGN_SUBKEY} > dev/ci_public_gpg_key.pgp
+    gpg --armor --export "${GPG_SIGN_SUBKEY}" > dev/ci_public_gpg_key.pgp
     gpg --export-ownertrust > dev/gpg_owner_trust
 
     # Encrypt gpg keys and trust with CI secret
     GLKWS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -e -a -in dev/ci_public_gpg_key.pgp > dev/ci_public_gpg_key.pgp.enc
     GLKWS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -e -a -in dev/ci_secret_gpg_subkeys.pgp > dev/ci_secret_gpg_subkeys.pgp.enc
     GLKWS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -e -a -in dev/gpg_owner_trust > dev/gpg_owner_trust.enc
-    echo $MAIN_GPG_KEYID > dev/public_gpg_key
+    echo "$MAIN_GPG_KEYID" > dev/public_gpg_key
 
     # Test decrpyt
     GLKWS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/ci_public_gpg_key.pgp.enc | gpg --list-packets --verbose
     GLKWS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/ci_secret_gpg_subkeys.pgp.enc  | gpg --list-packets --verbose
-    GLKWS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/gpg_owner_trust.enc
+    GLKWS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/gpg_owner_trust.enc 
     cat dev/public_gpg_key
 
     unload_secrets
@@ -182,10 +428,16 @@ export_encrypted_code_signing_keys(){
 }
 
 
+# See the xcookie module gitlab python API
+#gitlab_set_protected_branches(){
+#}
+
+
 _test_gnu(){
+    # shellcheck disable=SC2155
     export GNUPGHOME=$(mktemp -d -t)
-    ls -al $GNUPGHOME
-    chmod 700 -R $GNUPGHOME
+    ls -al "$GNUPGHOME"
+    chmod 700 -R "$GNUPGHOME"
 
     source dev/secrets_configuration.sh
 
@@ -204,7 +456,6 @@ _test_gnu(){
     GLKWS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/gpg_owner_trust.enc | gpg --import-ownertrust
     GLKWS=$CI_SECRET openssl enc -aes-256-cbc -pbkdf2 -md SHA512 -pass env:GLKWS -d -a -in dev/ci_secret_gpg_subkeys.pgp.enc | gpg --import
 
-
     gpg -k
     # | gpg --import
     # | gpg --list-packets --verbose
diff --git a/publish.sh b/publish.sh
index 91dc1670..97e60bc0 100755
--- a/publish.sh
+++ b/publish.sh
@@ -1,10 +1,10 @@
 #!/bin/bash
-__heredoc__='''
+__doc__='''
 Script to publish a new version of this library on PyPI. 
 
 If your script has binary dependencies then we assume that you have built a
 proper binary wheel with auditwheel and it exists in the wheelhouse directory.
-Otherwise, for source tarballs and universal wheels this script runs the
+Otherwise, for source tarballs and wheels this script runs the
 setup.py script to create the wheels as well.
 
 Running this script with the default arguments will perform any builds and gpg
@@ -12,10 +12,54 @@ signing, but nothing will be uploaded to pypi unless the user explicitly sets
 DO_UPLOAD=True or answers yes to the prompts.
 
 Args:
-    # These environment variables must / should be set
-    TWINE_USERNAME : username for pypi
-    TWINE_PASSWORD : password for pypi
-    DO_GPG : defaults to True
+    TWINE_USERNAME (str) : 
+        username for pypi. This must be set if uploading to pypi.
+        Defaults to "".
+
+    TWINE_PASSWORD (str) : 
+        password for pypi. This must be set if uploading to pypi.
+        Defaults to "".
+
+    DO_GPG (bool) : 
+        If True, sign the packages with a GPG key specified by `GPG_KEYID`.
+        defaults to auto.
+
+    DO_UPLOAD (bool) : 
+        If True, upload the packages to the pypi server specified by
+        `TWINE_REPOSITORY_URL`.
+
+    DO_BUILD (bool) : 
+        If True, will execute the setup.py build script, which is
+        expected to use setuptools. In the future we may add support for other
+        build systems. If False, this script will expect the pre-built packages
+        to exist in "wheelhouse/{NAME}-{VERSION}-{SUFFIX}.{EXT}".
+
+        Defaults to "auto". 
+
+    DO_TAG (bool) : 
+        if True, will "git tag" the current HEAD with 
+
+    TWINE_REPOSITORY_URL (url) : 
+         The URL of the pypi server to upload to. 
+         Defaults to "auto", which if on the release branch, this will default
+         to the live pypi server `https://upload.pypi.org/legacy` otherwise
+         this will default to the test.pypi server:
+         `https://test.pypi.org/legacy`
+
+     GPG_KEYID (str) :
+        The keyid of the gpg key to sign with. (if DO_GPG=True). Defaults to
+        the local git config user.signingkey
+
+    DEPLOY_REMOTE (str) : 
+        The git remote to push any tags to. Defaults to "origin"
+
+    GPG_EXECUTABLE (path) : 
+        Path to the GPG executable. 
+        Defaults to "auto", which chooses "gpg2" if it exists, otherwise "gpg".
+
+    MODE (str):
+        Can be pure, binary, or all. Defaults to pure unless a CMakeLists.txt
+        exists in which case it defaults to binary.
 
 Requirements:
      twine >= 1.13.0
@@ -28,17 +72,26 @@ Notes:
     # https://packaging.python.org/tutorials/distributing-packages/
     # https://stackoverflow.com/questions/45188811/how-to-gpg-sign-a-file-that-is-built-by-travis-ci
 
+    Based on template in
+
+    # github.com/Erotemic/xcookie/
+    ~/code/xcookie/publish.sh
+
 Usage:
+    load_secrets
+    # TODO: set a trap to unload secrets?
     cd <YOUR REPO>
-
     # Set your variables or load your secrets
     export TWINE_USERNAME=<pypi-username>
     export TWINE_PASSWORD=<pypi-password>
     TWINE_REPOSITORY_URL="https://test.pypi.org/legacy/" 
-
-    source $(secret_loader.sh)
 '''
 
+DEBUG=${DEBUG:=''}
+if [[ "${DEBUG}" != "" ]]; then
+    set -x
+fi
+
 check_variable(){
     KEY=$1
     HIDE=$2
@@ -67,24 +120,34 @@ normalize_boolean(){
     fi
 }
 
+
+####
+# Parameters
+###
+
 # Options
 DEPLOY_REMOTE=${DEPLOY_REMOTE:=origin}
 NAME=${NAME:=$(python -c "import setup; print(setup.NAME)")}
 VERSION=$(python -c "import setup; print(setup.VERSION)")
 
-# The default should change depending on the application
-#DEFAULT_MODE_LIST=("sdist" "universal" "bdist")
-DEFAULT_MODE_LIST=("sdist" "native" "universal")
-#DEFAULT_MODE_LIST=("sdist" "bdist")
-
 check_variable DEPLOY_REMOTE
 
 ARG_1=$1
 
 DO_UPLOAD=${DO_UPLOAD:=$ARG_1}
 DO_TAG=${DO_TAG:=$ARG_1}
+
 DO_GPG=${DO_GPG:="auto"}
+# Verify that we want to build
+if [ "$DO_GPG" == "auto" ]; then
+    DO_GPG="True"
+fi
+
 DO_BUILD=${DO_BUILD:="auto"}
+# Verify that we want to build
+if [ "$DO_BUILD" == "auto" ]; then
+    DO_BUILD="True"
+fi
 
 DO_GPG=$(normalize_boolean "$DO_GPG")
 DO_BUILD=$(normalize_boolean "$DO_BUILD")
@@ -94,27 +157,78 @@ DO_TAG=$(normalize_boolean "$DO_TAG")
 TWINE_USERNAME=${TWINE_USERNAME:=""}
 TWINE_PASSWORD=${TWINE_PASSWORD:=""}
 
-if [[ "$(cat .git/HEAD)" != "ref: refs/heads/release" ]]; then 
-    # If we are not on release, then default to the test pypi upload repo
-    TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL:="https://test.pypi.org/legacy/"}
+DEFAULT_TEST_TWINE_REPO_URL="https://test.pypi.org/legacy/"
+DEFAULT_LIVE_TWINE_REPO_URL="https://upload.pypi.org/legacy/"
+
+TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL:="auto"}
+if [[ "${TWINE_REPOSITORY_URL}" == "auto" ]]; then
+    #if [[ "$(cat .git/HEAD)" != "ref: refs/heads/release" ]]; then 
+    #    # If we are not on release, then default to the test pypi upload repo
+    #    TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL:="https://test.pypi.org/legacy/"}
+    #else
+    if [[ "$DEBUG" == "" ]]; then
+        TWINE_REPOSITORY_URL="live"
+    else
+        TWINE_REPOSITORY_URL="test"
+    fi
+fi
+
+if [[ "${TWINE_REPOSITORY_URL}" == "live" ]]; then
+    TWINE_REPOSITORY_URL=$DEFAULT_LIVE_TWINE_REPO_URL
+elif [[ "${TWINE_REPOSITORY_URL}" == "test" ]]; then
+    TWINE_REPOSITORY_URL=$DEFAULT_TEST_TWINE_REPO_URL
+fi
+
+GPG_EXECUTABLE=${GPG_EXECUTABLE:="auto"}
+if [[ "$GPG_EXECUTABLE" == "auto" ]]; then
+    if [[ "$(which gpg2)" != "" ]]; then
+        GPG_EXECUTABLE="gpg2"
+    else
+        GPG_EXECUTABLE="gpg"
+    fi
+fi
+
+GPG_KEYID=${GPG_KEYID:="auto"}
+if [[ "$GPG_KEYID" == "auto" ]]; then
+    GPG_KEYID=$(git config --local user.signingkey)
+    if [[ "$GPG_KEYID" == "" ]]; then
+        GPG_KEYID=$(git config --global user.signingkey)
+    fi
+fi
+
+
+if [ -f CMakeLists.txt ] ; then
+    DEFAULT_MODE="binary"
 else
-    TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL:="https://upload.pypi.org/legacy/"}
+    DEFAULT_MODE="pure"
 fi
 
-if [[ "$(which gpg2)" != "" ]]; then
-    GPG_EXECUTABLE=${GPG_EXECUTABLE:=gpg2}
+
+# TODO: parameterize
+# The default should change depending on the application
+MODE=${MODE:=$DEFAULT_MODE}
+if [[ "$MODE" == "all" ]]; then
+    MODE_LIST=("sdist" "native" "bdist")
+elif [[ "$MODE" == "pure" ]]; then
+    MODE_LIST=("sdist" "native")
+elif [[ "$MODE" == "binary" ]]; then
+    MODE_LIST=("sdist" "bdist")
 else
-    GPG_EXECUTABLE=${GPG_EXECUTABLE:=gpg}
+    MODE_LIST=("$MODE")
 fi
+MODE_LIST_STR=$(printf '"%s" ' "${MODE_LIST[@]}")
+#echo "MODE_LIST_STR = $MODE_LIST_STR"
 
-GPG_KEYID=${GPG_KEYID:=$(git config --local user.signingkey)}
-GPG_KEYID=${GPG_KEYID:=$(git config --global user.signingkey)}
 
-WAS_INTERACTION="False"
+####
+# Logic
+###
 
+WAS_INTERACTION="False"
 
 echo "
 === PYPI BUILDING SCRIPT ==
+NAME='$NAME'
 VERSION='$VERSION'
 TWINE_USERNAME='$TWINE_USERNAME'
 TWINE_REPOSITORY_URL = $TWINE_REPOSITORY_URL
@@ -124,6 +238,7 @@ DO_UPLOAD=${DO_UPLOAD}
 DO_TAG=${DO_TAG}
 DO_GPG=${DO_GPG}
 DO_BUILD=${DO_BUILD}
+MODE_LIST_STR=${MODE_LIST_STR}
 "
 
 
@@ -134,6 +249,7 @@ else
     if [[ "$DO_TAG" == "False" ]]; then
         echo "We are NOT about to tag VERSION='$VERSION'" 
     else
+        # shellcheck disable=SC2162
         read -p "Do you want to git tag and push version='$VERSION'? (input 'yes' to confirm)" ANS
         echo "ANS = $ANS"
         WAS_INTERACTION="True"
@@ -147,14 +263,6 @@ else
 fi
 
 
-# Verify that we want to build
-if [ "$DO_BUILD" == "auto" ]; then
-    DO_BUILD="True"
-fi
-# Verify that we want to build
-if [ "$DO_GPG" == "auto" ]; then
-    DO_GPG="True"
-fi
 
 if [[ "$DO_BUILD" == "True" ]]; then
     echo "About to build wheels"
@@ -162,6 +270,7 @@ else
     if [[ "$DO_BUILD" == "False" ]]; then
         echo "We are NOT about to build wheels"
     else
+        # shellcheck disable=SC2162
         read -p "Do you need to build wheels? (input 'yes' to confirm)" ANS
         echo "ANS = $ANS"
         WAS_INTERACTION="True"
@@ -178,6 +287,7 @@ else
     if [[ "$DO_UPLOAD" == "False" ]]; then
         echo "We are NOT about to directly publish VERSION='$VERSION'" 
     else
+        # shellcheck disable=SC2162
         read -p "Are you ready to directly publish version='$VERSION'? ('yes' will twine upload)" ANS
         echo "ANS = $ANS"
         WAS_INTERACTION="True"
@@ -199,22 +309,12 @@ if [[ "$WAS_INTERACTION" == "True" ]]; then
     DO_TAG=${DO_TAG}
     DO_GPG=${DO_GPG}
     DO_BUILD=${DO_BUILD}
+    MODE_LIST_STR='${MODE_LIST_STR}'
     "
-    read -p "Look good? Ready? Enter any text to continue" ANS
-fi
-
-
-
-MODE=${MODE:=all}
-
-if [[ "$MODE" == "all" ]]; then
-    MODE_LIST=("${DEFAULT_MODE_LIST[@]}")
-else
-    MODE_LIST=("$MODE")
+    # shellcheck disable=SC2162
+    read -p "Look good? Ready to build? Enter any text to continue" ANS
 fi
 
-MODE_LIST_STR=$(printf '"%s" ' "${MODE_LIST[@]}")
-
 
 
 if [ "$DO_BUILD" == "True" ]; then
@@ -225,33 +325,19 @@ if [ "$DO_BUILD" == "True" ]; then
 
     echo "LIVE BUILDING"
     # Build wheel and source distribution
-
-    #WHEEL_PATHS=()
     for _MODE in "${MODE_LIST[@]}"
     do
         echo "_MODE = $_MODE"
         if [[ "$_MODE" == "sdist" ]]; then
             python setup.py sdist || { echo 'failed to build sdist wheel' ; exit 1; }
-            WHEEL_PATH=$(ls dist/$NAME-$VERSION*.tar.gz)
-            #WHEEL_PATHS+=($WHEEL_PATH)
         elif [[ "$_MODE" == "native" ]]; then
             python setup.py bdist_wheel || { echo 'failed to build native wheel' ; exit 1; }
-            WHEEL_PATH=$(ls dist/$NAME-$VERSION*.whl)
-            #WHEEL_PATHS+=($WHEEL_PATH)
-        elif [[ "$_MODE" == "universal" ]]; then
-            python setup.py bdist_wheel --universal || { echo 'failed to build universal wheel' ; exit 1; }
-            UNIVERSAL_TAG="py3-none-any"
-            WHEEL_PATH=$(ls dist/$NAME-$VERSION-$UNIVERSAL_TAG*.whl)
-            #WHEEL_PATHS+=($WHEEL_PATH)
         elif [[ "$_MODE" == "bdist" ]]; then
             echo "Assume wheel has already been built"
-            WHEEL_PATH=$(ls wheelhouse/$NAME-$VERSION-*.whl)
-            #WHEEL_PATHS+=($WHEEL_PATH)
         else
-            echo "bad mode"
+            echo "ERROR: bad mode"
             exit 1
         fi
-        echo "WHEEL_PATH = $WHEEL_PATH"
     done
 
     echo "
@@ -263,36 +349,69 @@ else
 fi
 
 
+ls_array(){
+    __doc__='
+    Read the results of a glob pattern into an array
+
+    Args:
+        arr_name
+        glob_pattern
+
+    Example:
+        arr_name="myarray"
+        glob_pattern="*"
+        pass
+    '
+    local arr_name="$1"
+    local glob_pattern="$2"
+    shopt -s nullglob
+    # shellcheck disable=SC2206
+    array=($glob_pattern)
+    shopt -u nullglob # Turn off nullglob to make sure it doesn't interfere with anything later
+    # FIXME; for some reason this doesnt always work properly
+    # Copy the array into the dynamically named variable
+    # shellcheck disable=SC2086
+    readarray -t $arr_name < <(printf '%s\n' "${array[@]}")
+}
+
+
 WHEEL_PATHS=()
 for _MODE in "${MODE_LIST[@]}"
 do
-    echo "_MODE = $_MODE"
     if [[ "$_MODE" == "sdist" ]]; then
-        WHEEL_PATH=$(ls dist/$NAME-$VERSION*.tar.gz)
-        WHEEL_PATHS+=($WHEEL_PATH)
+        ls_array "_NEW_WHEEL_PATHS" "dist/${NAME}-${VERSION}*.tar.gz"
     elif [[ "$_MODE" == "native" ]]; then
-        WHEEL_PATH=$(ls dist/$NAME-$VERSION*.whl)
-        WHEEL_PATHS+=($WHEEL_PATH)
-    elif [[ "$_MODE" == "universal" ]]; then
-        UNIVERSAL_TAG="py3-none-any"
-        WHEEL_PATH=$(ls dist/$NAME-$VERSION-$UNIVERSAL_TAG*.whl)
-        WHEEL_PATHS+=($WHEEL_PATH)
+        ls_array "_NEW_WHEEL_PATHS" "dist/${NAME}-${VERSION}*.whl"
     elif [[ "$_MODE" == "bdist" ]]; then
-        WHEEL_PATH=$(ls wheelhouse/$NAME-$VERSION-*.whl)
-        WHEEL_PATHS+=($WHEEL_PATH)
+        ls_array "_NEW_WHEEL_PATHS" "wheelhouse/${NAME}-${VERSION}-*.whl"
     else
-        echo "bad mode"
+        echo "ERROR: bad mode"
         exit 1
     fi
-    echo "WHEEL_PATH = $WHEEL_PATH"
+    # hacky CONCAT because for some reason ls_array will return 
+    # something that looks empty but has one empty element
+    for new_item in "${_NEW_WHEEL_PATHS[@]}"
+    do
+        if [[ "$new_item" != "" ]]; then
+            WHEEL_PATHS+=("$new_item")
+        fi
+    done
 done
 
+# Dedup the paths
+readarray -t WHEEL_PATHS < <(printf '%s\n' "${WHEEL_PATHS[@]}" | sort -u)
+
 WHEEL_PATHS_STR=$(printf '"%s" ' "${WHEEL_PATHS[@]}")
+echo "WHEEL_PATHS_STR = $WHEEL_PATHS_STR"
 
 echo "
+
+GLOBED
+------
 MODE=$MODE
 VERSION='$VERSION'
 WHEEL_PATHS='$WHEEL_PATHS_STR'
+
 "
 
 
@@ -317,13 +436,13 @@ if [ "$DO_GPG" == "True" ]; then
             echo "Signing wheels"
             GPG_SIGN_CMD="$GPG_EXECUTABLE --batch --yes --detach-sign --armor --local-user $GPG_KEYID"
             echo "GPG_SIGN_CMD = $GPG_SIGN_CMD"
-            $GPG_SIGN_CMD --output $WHEEL_PATH.asc $WHEEL_PATH
+            $GPG_SIGN_CMD --output "$WHEEL_PATH".asc "$WHEEL_PATH"
 
             echo "Checking wheels"
-            twine check $WHEEL_PATH.asc $WHEEL_PATH || { echo 'could not check wheels' ; exit 1; }
+            twine check "$WHEEL_PATH".asc "$WHEEL_PATH" || { echo 'could not check wheels' ; exit 1; }
 
             echo "Verifying wheels"
-            $GPG_EXECUTABLE --verify $WHEEL_PATH.asc $WHEEL_PATH || { echo 'could not verify wheels' ; exit 1; }
+            $GPG_EXECUTABLE --verify "$WHEEL_PATH".asc "$WHEEL_PATH" || { echo 'could not verify wheels' ; exit 1; }
     done
     echo "
     === <END GPG SIGN> ===
@@ -339,9 +458,10 @@ if [[ "$DO_TAG" == "True" ]]; then
     # git push origin :refs/tags/$TAG_NAME
     # and then tag with -f
     # 
-    git tag $TAG_NAME -m "tarball tag $VERSION"
+    git tag "$TAG_NAME" -m "tarball tag $VERSION"
     git push --tags $DEPLOY_REMOTE
     echo "Should also do a: git push $DEPLOY_REMOTE main:release"
+    echo "For github should draft a new release: https://github.com/PyUtils/line_profiler/releases/new"
 else
     echo "Not tagging"
 fi
@@ -354,13 +474,13 @@ if [[ "$DO_UPLOAD" == "True" ]]; then
     for WHEEL_PATH in "${WHEEL_PATHS[@]}"
     do
         if [ "$DO_GPG" == "True" ]; then
-            twine upload --username $TWINE_USERNAME --password=$TWINE_PASSWORD  \
-                --repository-url $TWINE_REPOSITORY_URL \
-                --sign $WHEEL_PATH.asc $WHEEL_PATH --skip-existing --verbose || { echo 'failed to twine upload' ; exit 1; }
+            twine upload --username "$TWINE_USERNAME" --password=$TWINE_PASSWORD  \
+                --repository-url "$TWINE_REPOSITORY_URL" \
+                --sign "$WHEEL_PATH".asc "$WHEEL_PATH" --skip-existing --verbose || { echo 'failed to twine upload' ; exit 1; }
         else
-            twine upload --username $TWINE_USERNAME --password=$TWINE_PASSWORD \
-                --repository-url $TWINE_REPOSITORY_URL \
-                $WHEEL_PATH --skip-existing --verbose || { echo 'failed to twine upload' ; exit 1; }
+            twine upload --username "$TWINE_USERNAME" --password=$TWINE_PASSWORD \
+                --repository-url "$TWINE_REPOSITORY_URL" \
+                "$WHEEL_PATH" --skip-existing --verbose || { echo 'failed to twine upload' ; exit 1; }
         fi
     done
     echo """
@@ -368,7 +488,7 @@ if [[ "$DO_UPLOAD" == "True" ]]; then
     """
 else
     echo """
-        DRY RUN ... Skiping upload
+        DRY RUN ... Skipping upload
 
         DEPLOY_REMOTE = '$DEPLOY_REMOTE'
         DO_UPLOAD = '$DO_UPLOAD'
@@ -380,7 +500,6 @@ else
         NAME='$NAME'
         TWINE_USERNAME='$TWINE_USERNAME'
         GPG_KEYID = '$GPG_KEYID'
-        MB_PYTHON_TAG = '$MB_PYTHON_TAG'
 
         To do live run set DO_UPLOAD=1 and ensure deploy and current branch are the same
 
diff --git a/run_doctests.sh b/run_doctests.sh
index 6a1cb84d..3b6d0645 100755
--- a/run_doctests.sh
+++ b/run_doctests.sh
@@ -1,2 +1,2 @@
 #!/bin/bash
-xdoctest xdoctest --style=google all $@
+xdoctest xdoctest --style=google all "$@"
diff --git a/run_tests.py b/run_tests.py
index 06df7e5c..b9657c4f 100755
--- a/run_tests.py
+++ b/run_tests.py
@@ -1,23 +1,19 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 if __name__ == '__main__':
     import pytest
     import sys
     package_name = 'xdoctest'
-    package_dpath = package_name
+    mod_dpath = package_name
+    test_dpath = 'tests'
     pytest_args = [
         '-p', 'pytester',
         '-p', 'no:doctest',
-        '--xdoctest',
-        '--cov-config', '.coveragerc',
+        '--cov-config', 'pyproject.toml',
         '--cov-report', 'html',
         '--cov-report', 'term',
+        '--xdoctest',
         '--cov=' + package_name,
-        package_dpath, 'testing'
+        mod_dpath, test_dpath
     ]
     pytest_args = pytest_args + sys.argv[1:]
-    print('pytest.__version__ = {!r}'.format(pytest.__version__))
-    print('pytest_args = {!r}'.format(pytest_args))
-    ret = pytest.main(pytest_args)
-    print('ret = {!r}'.format(ret))
-    sys.exit(ret)
+    sys.exit(pytest.main(pytest_args))
diff --git a/setup.py b/setup.py
index 8299ff21..101a1b42 100755
--- a/setup.py
+++ b/setup.py
@@ -13,39 +13,79 @@ def parse_version(fpath):
     """
     Statically parse the version number from a python file
     """
+    value = static_parse("__version__", fpath)
+    return value
+
+
+def static_parse(varname, fpath):
+    """
+    Statically parse the a constant variable from a python file
+    """
     import ast
+
     if not exists(fpath):
-        raise ValueError('fpath={!r} does not exist'.format(fpath))
-    with open(fpath, 'r') as file_:
+        raise ValueError("fpath={!r} does not exist".format(fpath))
+    with open(fpath, "r") as file_:
         sourcecode = file_.read()
     pt = ast.parse(sourcecode)
-    class VersionVisitor(ast.NodeVisitor):
+
+    class StaticVisitor(ast.NodeVisitor):
         def visit_Assign(self, node):
             for target in node.targets:
-                if getattr(target, 'id', None) == '__version__':
-                    self.version = node.value.s
-    visitor = VersionVisitor()
+                if getattr(target, "id", None) == varname:
+                    self.static_value = node.value.s
+
+    visitor = StaticVisitor()
     visitor.visit(pt)
-    return visitor.version
+    try:
+        value = visitor.static_value
+    except AttributeError:
+        import warnings
 
+        value = "Unknown {}".format(varname)
+        warnings.warn(value)
+    return value
 
-def parse_requirements(fname='requirements.txt', with_version=False):
+
+def parse_description():
+    """
+    Parse the description in the README file
+
+    CommandLine:
+        pandoc --from=markdown --to=rst --output=README.rst README.md
+        python -c "import setup; print(setup.parse_description())"
+    """
+    from os.path import dirname, join, exists
+
+    readme_fpath = join(dirname(__file__), "README.rst")
+    # This breaks on pip install, so check that it exists.
+    if exists(readme_fpath):
+        with open(readme_fpath, "r") as f:
+            text = f.read()
+        return text
+    return ""
+
+
+def parse_requirements(fname="requirements.txt", versions=False):
     """
     Parse the package dependencies listed in a requirements file but strips
     specific versioning information.
 
     Args:
         fname (str): path to requirements file
-        with_version (bool, default=False): if true include version specs
+        versions (bool | str, default=False):
+            If true include version specs.
+            If strict, then pin to the minimum version.
 
     Returns:
         List[str]: list of requirements items
     """
     from os.path import exists, dirname, join
     import re
+
     require_fpath = fname
 
-    def parse_line(line, dpath=''):
+    def parse_line(line, dpath=""):
         """
         Parse information from a line in a requirements text file
 
@@ -53,140 +93,78 @@ def parse_line(line, dpath=''):
         line = '-e git+https://a.com/somedep@sometag#egg=SomeDep'
         """
         # Remove inline comments
-        comment_pos = line.find(' #')
+        comment_pos = line.find(" #")
         if comment_pos > -1:
             line = line[:comment_pos]
 
-        if line.startswith('-r '):
+        if line.startswith("-r "):
             # Allow specifying requirements in other files
-            target = join(dpath, line.split(' ')[1])
+            target = join(dpath, line.split(" ")[1])
             for info in parse_require_file(target):
                 yield info
         else:
             # See: https://www.python.org/dev/peps/pep-0508/
-            info = {'line': line}
-            if line.startswith('-e '):
-                info['package'] = line.split('#egg=')[1]
+            info = {"line": line}
+            if line.startswith("-e "):
+                info["package"] = line.split("#egg=")[1]
             else:
-                if ';' in line:
-                    pkgpart, platpart = line.split(';')
+                if ";" in line:
+                    pkgpart, platpart = line.split(";")
                     # Handle platform specific dependencies
                     # setuptools.readthedocs.io/en/latest/setuptools.html
                     # #declaring-platform-specific-dependencies
                     plat_deps = platpart.strip()
-                    info['platform_deps'] = plat_deps
+                    info["platform_deps"] = plat_deps
                 else:
                     pkgpart = line
                     platpart = None
 
                 # Remove versioning from the package
-                pat = '(' + '|'.join(['>=', '==', '>']) + ')'
+                pat = "(" + "|".join([">=", "==", ">"]) + ")"
                 parts = re.split(pat, pkgpart, maxsplit=1)
                 parts = [p.strip() for p in parts]
 
-                info['package'] = parts[0]
+                info["package"] = parts[0]
                 if len(parts) > 1:
                     op, rest = parts[1:]
                     version = rest  # NOQA
-                    info['version'] = (op, version)
+                    info["version"] = (op, version)
             yield info
 
     def parse_require_file(fpath):
         dpath = dirname(fpath)
-        with open(fpath, 'r') as f:
+        with open(fpath, "r") as f:
             for line in f.readlines():
                 line = line.strip()
-                if line and not line.startswith('#'):
+                if line and not line.startswith("#"):
                     for info in parse_line(line, dpath=dpath):
                         yield info
 
     def gen_packages_items():
         if exists(require_fpath):
             for info in parse_require_file(require_fpath):
-                parts = [info['package']]
-                if with_version and 'version' in info:
-                    parts.extend(info['version'])
-                if not sys.version.startswith('3.4'):
+                parts = [info["package"]]
+                if versions and "version" in info:
+                    if versions == "strict":
+                        # In strict mode, we pin to the minimum version
+                        if info["version"]:
+                            # Only replace the first >= instance
+                            verstr = "".join(info["version"]).replace(">=", "==", 1)
+                            parts.append(verstr)
+                    else:
+                        parts.extend(info["version"])
+                if not sys.version.startswith("3.4"):
                     # apparently package_deps are broken in 3.4
-                    plat_deps = info.get('platform_deps')
+                    plat_deps = info.get("platform_deps")
                     if plat_deps is not None:
-                        parts.append(';' + plat_deps)
-                item = ''.join(parts)
+                        parts.append(";" + plat_deps)
+                item = "".join(parts)
                 yield item
 
     packages = list(gen_packages_items())
     return packages
 
 
-def parse_description():
-    """
-    Parse the description in the README file
-
-    CommandLine:
-        pandoc --from=markdown --to=rst --output=README.rst README.md
-        python -c "import setup; print(setup.parse_description())"
-    """
-    from os.path import dirname, join, exists
-    readme_fpath = join(dirname(__file__), 'README.rst')
-    # This breaks on pip install, so check that it exists.
-    if exists(readme_fpath):
-        with open(readme_fpath, 'r') as f:
-            text = f.read()
-        return text
-    return ''
-
-
-def native_mb_python_tag(plat_impl=None, version_info=None):
-    """
-    Get the correct manylinux python version tag for this interpreter
-
-    Example:
-        >>> print(native_mb_python_tag())
-        >>> print(native_mb_python_tag('PyPy', (2, 7)))
-        >>> print(native_mb_python_tag('CPython', (3, 8)))
-    """
-    if plat_impl is None:
-        import platform
-        plat_impl = platform.python_implementation()
-
-    if version_info is None:
-        import sys
-        version_info = sys.version_info
-
-    major, minor = version_info[0:2]
-    major, minor = version_info[0:2]
-    if minor > 9:
-        ver = '{}_{}'.format(major, minor)
-    else:
-        ver = '{}{}'.format(major, minor)
-
-    if plat_impl == 'CPython':
-        # TODO: get if cp27m or cp27mu
-        impl = 'cp'
-        if ver == '27':
-            IS_27_BUILT_WITH_UNICODE = True  # how to determine this?
-            if IS_27_BUILT_WITH_UNICODE:
-                abi = 'mu'
-            else:
-                abi = 'm'
-        else:
-            import sys
-            if sys.version_info[:2] >= (3, 8):
-                # bpo-36707: 3.8 dropped the m flag
-                abi = ''
-            else:
-                abi = 'm'
-        mb_tag = '{impl}{ver}-{impl}{ver}{abi}'.format(**locals())
-    elif plat_impl == 'PyPy':
-        abi = ''
-        impl = 'pypy'
-        ver = '{}{}'.format(major, minor)
-        mb_tag = '{impl}-{ver}'.format(**locals())
-    else:
-        raise NotImplementedError(plat_impl)
-    return mb_tag
-
-
 NAME = 'xdoctest'
 try:
     VERSION = parse_version('xdoctest/__init__.py')
@@ -195,35 +173,39 @@ def native_mb_python_tag(plat_impl=None, version_info=None):
     print('failed to parse values in setup.py')
     VERSION = '???'
 
-try:
-    MB_PYTHON_TAG = native_mb_python_tag()
-except Exception:
-    # raise
-    MB_PYTHON_TAG = '???'
-
 
 from setuptools import find_packages  # NOQA
-setupkw = dict(
-    name=NAME,
-    version=VERSION,
-    author='Jon Crall',
-    author_email='erotemic@gmail.com',
-    url='https://github.com/Erotemic/xdoctest',
-    license='Apache 2',
-)
 
 
 if __name__ == '__main__':
+    setupkw = dict(
+        name=NAME,
+        version=VERSION,
+        author='Jon Crall',
+        author_email='erotemic@gmail.com',
+        url='https://github.com/Erotemic/xdoctest',
+        license='Apache 2',
+    )
+
+    setupkw["install_requires"] = parse_requirements("requirements/runtime.txt")
+    setupkw["extras_require"] = {
+        "all": parse_requirements("requirements.txt"),
+        "tests": parse_requirements("requirements/tests.txt"),
+        "optional": parse_requirements("requirements/optional.txt"),
+        "all-strict": parse_requirements("requirements.txt", versions="strict"),
+        "runtime-strict": parse_requirements(
+            "requirements/runtime.txt", versions="strict"
+        ),
+        "tests-strict": parse_requirements("requirements/tests.txt", versions="strict"),
+        "optional-strict": parse_requirements(
+            "requirements/optional.txt", versions="strict"
+        ),
+        'colors': parse_requirements('requirements/colors.txt'),
+        'jupyter': parse_requirements('requirements/jupyter.txt'),
+    }
+
     setupkw.update(dict(
         description='A rewrite of the builtin doctest module',
-        install_requires=parse_requirements('requirements/runtime.txt'),
-        extras_require={
-            'all': parse_requirements('requirements.txt'),
-            'tests': parse_requirements('requirements/tests.txt'),
-            'optional': parse_requirements('requirements/optional.txt'),
-            'colors': parse_requirements('requirements/colors.txt'),
-            'jupyter': parse_requirements('requirements/jupyter.txt'),
-        },
         long_description=parse_description(),
         long_description_content_type='text/x-rst',
         entry_points={
@@ -239,6 +221,7 @@ def native_mb_python_tag(plat_impl=None, version_info=None):
         packages=find_packages('.'),
         # packages=['xdoctest', 'xdoctest.utils', 'xdoctest.docstr'],
         # custom PyPI classifier for pytest plugins
+        python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*',
         classifiers=[
             'Development Status :: 5 - Production/Stable',
             'Intended Audience :: Developers',
@@ -256,7 +239,6 @@ def native_mb_python_tag(plat_impl=None, version_info=None):
             'Programming Language :: Python :: 3.7',
             'Programming Language :: Python :: 3.6',
             'Programming Language :: Python :: 3.5',
-            'Programming Language :: Python :: 3.4',
             'Programming Language :: Python :: 2.7',
             'Programming Language :: Python :: Implementation :: PyPy',
             'Programming Language :: Python :: Implementation :: CPython',
diff --git a/xdoctest/docstr/docscrape_google.py b/xdoctest/docstr/docscrape_google.py
index c42a4953..feea1637 100644
--- a/xdoctest/docstr/docscrape_google.py
+++ b/xdoctest/docstr/docscrape_google.py
@@ -303,7 +303,7 @@ def parse_google_returns(docstr, return_annot=None):
         >>> docstr = split_google_docblocks.__doc__
         >>> retdict_list = list(parse_google_returns(docstr))
         >>> print([sorted(d.items())[1] for d in retdict_list])
-        [('type', 'List[Tuple]')]
+        [('type', 'List[Tuple[str, DocBlock[str, int]]]')]
     """
     blocks = split_google_docblocks(docstr)
     for key, block in blocks:

From fc603a66d4990d8c7c1fa7e0f8cafd4bdf3f7ca5 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 18:20:06 -0400
Subject: [PATCH 12/38] Change the testing directory to tests

---
 clean.sh                                      |   6 +-
 pytest.ini                                    |   4 +-
 testing/test_import.py                        | 390 ------------------
 .../notebook_with_doctests.ipynb              |   0
 .../pybind11_test/CMakeLists.txt              |   0
 {testing => tests}/pybind11_test/clean.sh     |   0
 {testing => tests}/pybind11_test/my_ext.cxx   |   0
 .../pybind11_test/run_dynamic_test.sh         |   0
 {testing => tests}/pybind11_test/setup.py     |   0
 {testing => tests}/test_binary_ext.py         |  16 +-
 {testing => tests}/test_cases.py              |   0
 {testing => tests}/test_checker.py            |   6 +-
 {testing => tests}/test_core.py               |  28 +-
 {testing => tests}/test_directive.py          |  10 +-
 {testing => tests}/test_doctest_example.py    |  32 +-
 .../test_doctest_in_notebook.ipynb            |   0
 {testing => tests}/test_dynamic.py            |   8 +-
 {testing => tests}/test_entry_point.py        |   4 +-
 {testing => tests}/test_errors.py             |  14 +-
 tests/test_import.py                          |   2 +
 {testing => tests}/test_limitations.py        |   0
 {testing => tests}/test_notebook.py           |   6 +-
 {testing => tests}/test_parser.py             |  36 +-
 {testing => tests}/test_plugin.py             | 106 ++---
 {testing => tests}/test_pytest_cli.py         |   2 +-
 {testing => tests}/test_runner.py             |  28 +-
 {testing => tests}/test_static.py             |   4 +-
 {testing => tests}/test_traceback.py          |  22 +-
 xdoctest/checker.py                           |   4 +-
 xdoctest/constants.py                         |  56 +--
 xdoctest/demo.py                              |  27 +-
 xdoctest/dynamic_analysis.py                  |   4 +-
 xdoctest/plugin.py                            |  16 +-
 xdoctest/utils/util_path.py                   |   2 +-
 34 files changed, 226 insertions(+), 607 deletions(-)
 delete mode 100644 testing/test_import.py
 rename {testing => tests}/notebook_with_doctests.ipynb (100%)
 rename {testing => tests}/pybind11_test/CMakeLists.txt (100%)
 rename {testing => tests}/pybind11_test/clean.sh (100%)
 rename {testing => tests}/pybind11_test/my_ext.cxx (100%)
 rename {testing => tests}/pybind11_test/run_dynamic_test.sh (100%)
 rename {testing => tests}/pybind11_test/setup.py (100%)
 rename {testing => tests}/test_binary_ext.py (93%)
 rename {testing => tests}/test_cases.py (100%)
 rename {testing => tests}/test_checker.py (93%)
 rename {testing => tests}/test_core.py (94%)
 rename {testing => tests}/test_directive.py (89%)
 rename {testing => tests}/test_doctest_example.py (85%)
 rename {testing => tests}/test_doctest_in_notebook.ipynb (100%)
 rename {testing => tests}/test_dynamic.py (96%)
 rename {testing => tests}/test_entry_point.py (95%)
 rename {testing => tests}/test_errors.py (92%)
 create mode 100644 tests/test_import.py
 rename {testing => tests}/test_limitations.py (100%)
 rename {testing => tests}/test_notebook.py (92%)
 rename {testing => tests}/test_parser.py (93%)
 rename {testing => tests}/test_plugin.py (91%)
 rename {testing => tests}/test_pytest_cli.py (97%)
 rename {testing => tests}/test_runner.py (92%)
 rename {testing => tests}/test_static.py (96%)
 rename {testing => tests}/test_traceback.py (87%)

diff --git a/clean.sh b/clean.sh
index a4bd9b79..99d3f177 100755
--- a/clean.sh
+++ b/clean.sh
@@ -14,7 +14,11 @@ rm -rf pip-wheel-metadata
 rm -rf htmlcov
 rm -rf .coverage
 rm -rf __pycache__
-rm -rf testing/pybind11_test/tmp
+rm -rf tests/pybind11_test/tmp
+rm -rf tests/pybind11_test/_skbuild
+rm -rf tests/pybind11_test/my_ext.egg-info
+
+rm -rf .mypy_cache
 
 rm distutils.errors 2&> /dev/null || echo "skip rm"
 
diff --git a/pytest.ini b/pytest.ini
index b25ad93c..ad5d07a6 100644
--- a/pytest.ini
+++ b/pytest.ini
@@ -2,10 +2,10 @@
 # ON COVERAGE OF PYTEST PLUGINS:
 # http://pytest-cov.readthedocs.io/en/latest/plugins.html
 addopts = -p pytester -p no:doctest --xdoctest --ignore-glob=setup.py  --ignore=.tox --ignore=setup.py --ignore=dev
-norecursedirs = .git ignore build __pycache__ docs *.egg-info dev testing/pybind11_test setup.py
+norecursedirs = .git ignore build __pycache__ docs *.egg-info dev tests/pybind11_test setup.py
 # --pyargs --doctest-modules --ignore=.tox
 ;rsyncdirs = tox.ini pytest.py _pytest testing
-;python_files = test_*.py *_test.py testing/*/*.py
+;python_files = test_*.py *_test.py tests/*/*.py
 ;python_classes = Test Acceptance
 ;python_functions = test
 ;norecursedirs = .tox ja .hg cx_freeze_source
diff --git a/testing/test_import.py b/testing/test_import.py
deleted file mode 100644
index 5fbc9cc7..00000000
--- a/testing/test_import.py
+++ /dev/null
@@ -1,390 +0,0 @@
-# -*- coding: utf-8 -*-
-from __future__ import print_function, division, absolute_import, unicode_literals
-from os.path import join
-import itertools as it
-import sys
-import pytest
-from xdoctest import static_analysis as static
-from xdoctest import utils
-
-
-def touch(args):
-    path = join(*args)
-    with open(path, 'w') as file:
-        file.write('')
-    return path
-
-
-def _static_modname_to_modpath(modname, **kwargs):
-    # Calls static.modname_to_modpath with checks
-    had = modname in sys.modules
-    try:
-        modpath = static.modname_to_modpath(modname, **kwargs)
-    except ValueError:
-        modpath = None
-    if not had:
-        assert modname not in sys.modules, (
-            '{} should not be imported'.format(modname))
-    return modpath
-
-
-def test_modname_to_modpath_package():
-    """
-    CommandLine:
-        pytest testing/test_static.py::test_modname_to_modpath_package
-
-    Ignore:
-        import sys
-        sys.path.append('/home/joncrall/code/xdoctest/testing')
-        from test_static import *
-        temp = utils.TempDir()
-        temp.__enter__()
-        sys.path.append(temp.dpath)
-
-        temp.__exit__(None, None, None)
-    """
-    with utils.TempDir() as temp:
-        dpath = temp.dpath
-
-        # Create a dummy package hierarchy
-        root = utils.ensuredir((dpath, '_tmproot'))
-        sub1 = utils.ensuredir((root, 'sub1'))
-        sub2 = utils.ensuredir((sub1, 'sub2'))
-
-        root_init = touch((root, '__init__.py'))
-        sub1_init = touch((sub1, '__init__.py'))
-        sub2_init = touch((sub2, '__init__.py'))
-
-        mod0 = touch((root, 'mod0.py'))
-        mod1 = touch((sub1, 'mod1.py'))
-        mod2 = touch((sub2, 'mod2.py'))
-
-        root_main = touch((root, '__main__.py'))
-        sub2_main = touch((sub2, '__main__.py'))
-
-        bad1 = utils.ensuredir((root, 'bad1'))
-        bad2 = utils.ensuredir((sub1, 'bad2'))
-        touch((bad1, 'b0.py'))
-        touch((bad2, 'b0.py'))
-
-        with utils.PythonPathContext(dpath):
-            # Bad module directories should return None
-            assert _static_modname_to_modpath('_tmproot.bad1') is None
-            assert _static_modname_to_modpath('_tmproot.sub1.bad1') is None
-            assert _static_modname_to_modpath('_tmproot.bad1.b0') is None
-            assert _static_modname_to_modpath('_tmproot.sub1.bad1.b1') is None
-            assert _static_modname_to_modpath('_tmproot.bad1') is None
-
-            # package modules are accessible by the full path
-            assert root == _static_modname_to_modpath('_tmproot')
-            assert sub1 == _static_modname_to_modpath('_tmproot.sub1')
-            assert sub2 == _static_modname_to_modpath('_tmproot.sub1.sub2')
-            assert mod0 == _static_modname_to_modpath('_tmproot.mod0')
-            assert mod1 == _static_modname_to_modpath('_tmproot.sub1.mod1')
-            assert mod2 == _static_modname_to_modpath('_tmproot.sub1.sub2.mod2')
-
-            # specifying a suffix will not work
-            assert _static_modname_to_modpath('sub1') is None
-            assert _static_modname_to_modpath('sub1.sub2') is None
-            assert _static_modname_to_modpath('mod0') is None
-            assert _static_modname_to_modpath('sub1.mod1') is None
-            assert _static_modname_to_modpath('sub1.sub2.mod2') is None
-
-            # Specify init if available
-            assert root_init == _static_modname_to_modpath('_tmproot', hide_init=False)
-
-            if 1:
-                # Test init
-                assert _static_modname_to_modpath('_tmproot', hide_init=False) == root_init
-                assert _static_modname_to_modpath('_tmproot.__init__', hide_init=False) == root_init
-                assert _static_modname_to_modpath('_tmproot.__main__', hide_init=False, hide_main=True) == root
-
-                # Test main
-                assert _static_modname_to_modpath('_tmproot', hide_main=False) == root
-                assert _static_modname_to_modpath('_tmproot.__init__', hide_main=False) == root
-                assert _static_modname_to_modpath('_tmproot.__main__', hide_main=False) == root_main
-
-                # Test init and main both false
-                assert _static_modname_to_modpath('_tmproot.__init__') == root
-                assert _static_modname_to_modpath('_tmproot.__main__', hide_main=True) == root
-
-                # Test init and main both true
-                assert _static_modname_to_modpath('_tmproot', hide_init=False, hide_main=False) == root_init
-                assert _static_modname_to_modpath('_tmproot.__init__', hide_init=False, hide_main=False) == root_init
-                assert _static_modname_to_modpath('_tmproot.__main__', hide_init=False, hide_main=False) == root_main
-
-            if 2:
-                # Test in a nested directory
-                # Test init
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2', hide_init=False) == sub2_init
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2.__init__', hide_init=False) == sub2_init
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2.__main__', hide_init=False, hide_main=True) == sub2
-
-                # Test main
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2', hide_main=False) == sub2
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2.__main__', hide_main=False) == sub2_main
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2.__init__', hide_main=False) == sub2
-
-                # Test init and main both false
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2.__init__', hide_main=True) == sub2
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2.__main__', hide_main=True) == sub2
-
-                # Test init and main both true
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2', hide_init=False, hide_main=False) == sub2_init
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2.__init__', hide_init=False, hide_main=False) == sub2_init
-                assert _static_modname_to_modpath('_tmproot.sub1.sub2.__main__', hide_init=False, hide_main=False) == sub2_main
-
-            if 3:
-                # Test in a nested directory with __init__ but no __main__
-                # Test init
-                assert _static_modname_to_modpath('_tmproot.sub1', hide_init=False) == sub1_init
-                assert _static_modname_to_modpath('_tmproot.sub1.__init__', hide_init=False) == sub1_init
-                assert _static_modname_to_modpath('_tmproot.sub1.__main__', hide_init=False) is None
-
-                # Test main
-                assert _static_modname_to_modpath('_tmproot.sub1', hide_main=False) == sub1
-                assert _static_modname_to_modpath('_tmproot.sub1.__main__', hide_main=False) is None
-                assert _static_modname_to_modpath('_tmproot.sub1.__init__', hide_main=False) == sub1
-
-                # Test init and main both false
-                assert _static_modname_to_modpath('_tmproot.sub1.__init__') == sub1
-                assert _static_modname_to_modpath('_tmproot.sub1.__main__') is None
-
-                # Test init and main both true
-                assert _static_modname_to_modpath('_tmproot.sub1', hide_init=False, hide_main=False) == sub1_init
-                assert _static_modname_to_modpath('_tmproot.sub1.__init__', hide_init=False, hide_main=False) == sub1_init
-                assert _static_modname_to_modpath('_tmproot.sub1.__main__', hide_init=False, hide_main=False) is None
-
-            assert '_tmproot' not in sys.modules
-            assert '_tmproot.mod0' not in sys.modules
-            assert '_tmproot.sub1' not in sys.modules
-            assert '_tmproot.sub1.mod1' not in sys.modules
-            assert '_tmproot.sub1.sub2' not in sys.modules
-            assert '_tmproot.sub1.mod2.mod2' not in sys.modules
-
-
-def test_modname_to_modpath_single():
-    with utils.TempDir() as temp:
-        dpath = temp.dpath
-
-        # Single module
-        single = touch((dpath, '_tmpsingle.py'))
-        single_main = touch((dpath, '__main__.py'))
-
-        with utils.PythonPathContext(dpath):
-            assert single == _static_modname_to_modpath('_tmpsingle')
-            assert single == _static_modname_to_modpath('_tmpsingle', hide_init=True, hide_main=False)
-            assert single == _static_modname_to_modpath('_tmpsingle', hide_init=False, hide_main=False)
-            assert single == _static_modname_to_modpath('_tmpsingle', hide_init=False, hide_main=True)
-
-            # Weird module named main not in a package
-            assert _static_modname_to_modpath('__main__') == single_main
-            assert _static_modname_to_modpath('__main__', hide_init=True, hide_main=False) == single_main
-            assert _static_modname_to_modpath('__main__', hide_init=False, hide_main=False) == single_main
-            assert _static_modname_to_modpath('__main__', hide_init=False, hide_main=True) == single_main
-
-
-def test_modname_to_modpath_namespace():
-    """
-    Ignore:
-        import sys
-        sys.path.append('/home/joncrall/code/xdoctest/testing')
-        from test_static import *
-        temp = utils.TempDir()
-        temp.__enter__()
-        sys.path.append(temp.dpath)
-
-        temp.__exit__(None, None, None)
-
-    %timeit _syspath_modname_to_modpath('xdoctest.static_analysis')
-    %timeit _pkgutil_modname_to_modpath('xdoctest.static_analysis')
-    """
-    with utils.TempDir() as temp:
-        dpath = temp.dpath
-
-        # Some "bad" non-module directories
-        tmpbad = utils.ensuredir((dpath, '_tmpbad'))
-
-        # Make a submodule of a bad directory, look good.
-        sub_bad = utils.ensuredir((tmpbad, 'sub_bad'))
-        touch((tmpbad, '_inbad.py'))
-        subbad = touch((sub_bad, '__init__.py'))  # NOQA
-        b0 = touch((sub_bad, 'b0.py'))  # NOQA
-
-        with utils.PythonPathContext(dpath):
-            assert _static_modname_to_modpath('_tmpbad') is None
-
-            # Tricky case, these modules look good outside of _tmpbad WOW, you
-            # can actually import this and it works, but pkgloader still
-            # returns None so we should too.
-            assert _static_modname_to_modpath('_tmpbad.sub_bad') is None
-            assert _static_modname_to_modpath('_tmpbad.sub_bad.b0') is None
-
-            # We should be able to statically find all of the good module
-            # directories.
-
-            # this should all be static
-            import sys
-            assert '_tmpsingle' not in sys.modules
-            assert '_tmpbad' not in sys.modules
-
-
-def test_package_submodules():
-    """
-    CommandLine:
-        pytest testing/test_static.py::test_package_submodules -s
-        pass
-
-    Ignore:
-        import sys
-        sys.path.append('/home/joncrall/code/xdoctest/testing')
-        from test_static import *
-        temp = utils.TempDir()
-        temp.__enter__()
-        sys.path.append(temp.dpath)
-
-        temp.__exit__(None, None, None)
-    """
-    with utils.TempDir() as temp:
-        dpath = temp.dpath
-
-        # Create a dummy package hierarchy
-        root = utils.ensuredir((dpath, '_tmproot'))
-        sub1 = utils.ensuredir((root, 'sub1'))
-        sub2 = utils.ensuredir((sub1, 'sub2'))
-
-        root_init = touch((root, '__init__.py'))
-        sub1_init = touch((sub1, '__init__.py'))
-        sub2_init = touch((sub2, '__init__.py'))
-
-        mod0 = touch((root, 'mod0.py'))
-        mod1 = touch((sub1, 'mod1.py'))
-        mod2 = touch((sub2, 'mod2.py'))
-
-        root_main = touch((root, '__main__.py'))
-        sub2_main = touch((sub2, '__main__.py'))
-
-        bad1 = utils.ensuredir((root, 'bad1'))
-        bad2 = utils.ensuredir((sub1, 'bad2'))
-        b0 = touch((bad1, 'b0.py'))
-        b1 = touch((bad2, 'b1.py'))
-
-        with utils.PythonPathContext(dpath):
-            subpaths = sorted(static.package_modpaths(root, with_pkg=True))
-
-            # should only return files not directories
-            assert root_init in subpaths
-            assert sub1_init in subpaths
-            assert sub2_init in subpaths
-            assert root not in subpaths
-            assert sub1 not in subpaths
-            assert sub2 not in subpaths
-
-            assert root_main in subpaths
-            assert sub2_main in subpaths
-
-            assert mod0 in subpaths
-            assert mod1 in subpaths
-            assert mod2 in subpaths
-
-            assert bad1 not in subpaths
-            assert b0 not in subpaths
-            assert b1 not in subpaths
-
-            assert '_tmproot' not in sys.modules
-            assert '_tmproot.mod0' not in sys.modules
-            assert '_tmproot.sub1' not in sys.modules
-            assert '_tmproot.sub1.mod1' not in sys.modules
-            assert '_tmproot.sub1.sub2' not in sys.modules
-            assert '_tmproot.sub1.mod2.mod2' not in sys.modules
-
-
-def test_modpath_to_modname():
-    """
-    CommandLine:
-        pytest testing/test_static.py::test_modpath_to_modname -s
-        python testing/test_static.py test_modpath_to_modname
-    """
-    with utils.TempDir() as temp:
-        dpath = temp.dpath
-
-        # Create a dummy package hierarchy
-        root = utils.ensuredir((dpath, '_tmproot'))
-        sub1 = utils.ensuredir((root, 'sub1'))
-        sub2 = utils.ensuredir((sub1, 'sub2'))
-
-        root_init = touch((root, '__init__.py'))
-        sub1_init = touch((sub1, '__init__.py'))
-        sub2_init = touch((sub2, '__init__.py'))
-
-        mod0 = touch((root, 'mod0.py'))
-        mod1 = touch((sub1, 'mod1.py'))
-        mod2 = touch((sub2, 'mod2.py'))
-
-        root_main = touch((root, '__main__.py'))
-        sub2_main = touch((sub2, '__main__.py'))
-
-        bad1 = utils.ensuredir((root, 'bad1'))
-        bad2 = utils.ensuredir((sub1, 'bad2'))
-        b0 = touch((bad1, 'b0.py'))
-        b1 = touch((bad2, 'b1.py'))
-
-        with utils.PythonPathContext(dpath):
-
-            assert static.modpath_to_modname(root) == '_tmproot'
-            assert static.modpath_to_modname(sub1) == '_tmproot.sub1'
-            assert static.modpath_to_modname(sub2) == '_tmproot.sub1.sub2'
-
-            assert static.modpath_to_modname(mod0) == '_tmproot.mod0'
-            assert static.modpath_to_modname(mod1) == '_tmproot.sub1.mod1'
-            assert static.modpath_to_modname(mod2) == '_tmproot.sub1.sub2.mod2'
-
-            assert static.modpath_to_modname(root_init) == '_tmproot'
-            assert static.modpath_to_modname(sub1_init) == '_tmproot.sub1'
-            assert static.modpath_to_modname(sub2_init) == '_tmproot.sub1.sub2'
-
-            assert static.modpath_to_modname(root_init, hide_init=False) == '_tmproot.__init__'
-            assert static.modpath_to_modname(sub1_init, hide_init=False) == '_tmproot.sub1.__init__'
-            assert static.modpath_to_modname(sub2_init, hide_init=False) == '_tmproot.sub1.sub2.__init__'
-
-            assert static.modpath_to_modname(root, hide_main=True, hide_init=False) == '_tmproot.__init__'
-            assert static.modpath_to_modname(sub1, hide_main=True, hide_init=False) == '_tmproot.sub1.__init__'
-            assert static.modpath_to_modname(sub2, hide_main=True, hide_init=False) == '_tmproot.sub1.sub2.__init__'
-
-            assert static.modpath_to_modname(root, hide_main=False, hide_init=False) == '_tmproot.__init__'
-            assert static.modpath_to_modname(sub1, hide_main=False, hide_init=False) == '_tmproot.sub1.__init__'
-            assert static.modpath_to_modname(sub2, hide_main=False, hide_init=False) == '_tmproot.sub1.sub2.__init__'
-
-            assert static.modpath_to_modname(root, hide_main=False, hide_init=True) == '_tmproot'
-            assert static.modpath_to_modname(sub1, hide_main=False, hide_init=True) == '_tmproot.sub1'
-            assert static.modpath_to_modname(sub2, hide_main=False, hide_init=True) == '_tmproot.sub1.sub2'
-
-            assert static.modpath_to_modname(root_main, hide_main=False, hide_init=True) == '_tmproot.__main__'
-            assert static.modpath_to_modname(sub2_main, hide_main=False, hide_init=True) == '_tmproot.sub1.sub2.__main__'
-
-            assert static.modpath_to_modname(root_main, hide_main=False, hide_init=True) == '_tmproot.__main__'
-            assert static.modpath_to_modname(sub2_main, hide_main=False, hide_init=True) == '_tmproot.sub1.sub2.__main__'
-
-            assert static.modpath_to_modname(root_main, hide_main=True, hide_init=True) == '_tmproot'
-            assert static.modpath_to_modname(sub2_main, hide_main=True, hide_init=True) == '_tmproot.sub1.sub2'
-
-            assert static.modpath_to_modname(root_main, hide_main=True, hide_init=False) == '_tmproot'
-            assert static.modpath_to_modname(sub2_main, hide_main=True, hide_init=False) == '_tmproot.sub1.sub2'
-
-            # Non-existent / invalid modules should always be None
-            for a, b in it.product([True, False], [True, False]):
-                with pytest.raises(ValueError):
-                    static.modpath_to_modname(join(sub1, '__main__.py'), hide_main=a, hide_init=b)
-                assert static.modpath_to_modname(b0, hide_main=a, hide_init=b) == 'b0'
-                assert static.modpath_to_modname(b1, hide_main=a, hide_init=b) == 'b1'
-                with pytest.raises(ValueError):
-                    static.modpath_to_modname(bad1, hide_main=a, hide_init=b)
-                with pytest.raises(ValueError):
-                    static.modpath_to_modname(bad2, hide_main=a, hide_init=b)
-
-            assert '_tmproot' not in sys.modules
-            assert '_tmproot.mod0' not in sys.modules
-            assert '_tmproot.sub1' not in sys.modules
-            assert '_tmproot.sub1.mod1' not in sys.modules
-            assert '_tmproot.sub1.sub2' not in sys.modules
-            assert '_tmproot.sub1.mod2.mod2' not in sys.modules
diff --git a/testing/notebook_with_doctests.ipynb b/tests/notebook_with_doctests.ipynb
similarity index 100%
rename from testing/notebook_with_doctests.ipynb
rename to tests/notebook_with_doctests.ipynb
diff --git a/testing/pybind11_test/CMakeLists.txt b/tests/pybind11_test/CMakeLists.txt
similarity index 100%
rename from testing/pybind11_test/CMakeLists.txt
rename to tests/pybind11_test/CMakeLists.txt
diff --git a/testing/pybind11_test/clean.sh b/tests/pybind11_test/clean.sh
similarity index 100%
rename from testing/pybind11_test/clean.sh
rename to tests/pybind11_test/clean.sh
diff --git a/testing/pybind11_test/my_ext.cxx b/tests/pybind11_test/my_ext.cxx
similarity index 100%
rename from testing/pybind11_test/my_ext.cxx
rename to tests/pybind11_test/my_ext.cxx
diff --git a/testing/pybind11_test/run_dynamic_test.sh b/tests/pybind11_test/run_dynamic_test.sh
similarity index 100%
rename from testing/pybind11_test/run_dynamic_test.sh
rename to tests/pybind11_test/run_dynamic_test.sh
diff --git a/testing/pybind11_test/setup.py b/tests/pybind11_test/setup.py
similarity index 100%
rename from testing/pybind11_test/setup.py
rename to tests/pybind11_test/setup.py
diff --git a/testing/test_binary_ext.py b/tests/test_binary_ext.py
similarity index 93%
rename from testing/test_binary_ext.py
rename to tests/test_binary_ext.py
index 443702bd..0f5e05e5 100644
--- a/testing/test_binary_ext.py
+++ b/tests/test_binary_ext.py
@@ -84,12 +84,12 @@
 cd $HOME/code/xdoctest
 pip install -e .[all]
 
-python testing/test_binary_ext.py build_demo_extmod
+python tests/test_binary_ext.py build_demo_extmod
 
 
-cd /io/testing/pybind11_test
-mkdir -p /io/testing/pybind11_test/build
-cd /io/testing/pybind11_test/build
+cd /io/tests/pybind11_test
+mkdir -p /io/tests/pybind11_test/build
+cd /io/tests/pybind11_test/build
 cmake ..
 
 
@@ -99,7 +99,7 @@
 def build_demo_extmod():
     """
     CommandLine:
-        python testing/test_binary_ext.py build_demo_extmod
+        python tests/test_binary_ext.py build_demo_extmod
     """
     import os
     import glob
@@ -170,10 +170,10 @@ def test_run_binary_doctests():
     Tests that we can run doctests in a compiled pybind11 module
 
     CommandLine:
-        python ~/code/xdoctest/testing/test_binary_ext.py test_run_binary_doctests
+        python ~/code/xdoctest/tests/test_binary_ext.py test_run_binary_doctests
 
     Notes:
-        xdoctest -m $HOME/code/xdoctest/testing/pybind11_test/install/my_ext.cpython-38-x86_64-linux-gnu.so list --analysis=dynamic
+        xdoctest -m $HOME/code/xdoctest/tests/pybind11_test/install/my_ext.cpython-38-x86_64-linux-gnu.so list --analysis=dynamic
 
     """
     extmod_fpath = build_demo_extmod()
@@ -193,7 +193,7 @@ def test_run_binary_doctests():
 if __name__ == '__main__':
     """
     CommandLine:
-        python ~/code/xdoctest/testing/test_binary_ext.py
+        python ~/code/xdoctest/tests/test_binary_ext.py
     """
     import xdoctest
     xdoctest.doctest_module(__file__)
diff --git a/testing/test_cases.py b/tests/test_cases.py
similarity index 100%
rename from testing/test_cases.py
rename to tests/test_cases.py
diff --git a/testing/test_checker.py b/tests/test_checker.py
similarity index 93%
rename from testing/test_checker.py
rename to tests/test_checker.py
index 840cffd5..becfd3f7 100644
--- a/testing/test_checker.py
+++ b/tests/test_checker.py
@@ -5,7 +5,7 @@
 
 def test_visible_lines():
     """
-    pytest testing/test_checker.py
+    pytest tests/test_checker.py
     """
     got = 'this is invisible\ronly this is visible'
     print(got)
@@ -15,7 +15,7 @@ def test_visible_lines():
 
 def test_visible_lines_explicit():
     """
-    pytest testing/test_checker.py
+    pytest tests/test_checker.py
     """
     got = 'invisible\rIS-visible'
     want = 'invisible\rIS-visible'
@@ -26,7 +26,7 @@ def test_visible_lines_explicit():
 
 def test_blankline_accept():
     """
-    pytest testing/test_checker.py
+    pytest tests/test_checker.py
     """
     # Check that blankline is normalized away
     runstate = directive.RuntimeState({'DONT_ACCEPT_BLANKLINE': False})
diff --git a/testing/test_core.py b/tests/test_core.py
similarity index 94%
rename from testing/test_core.py
rename to tests/test_core.py
index 23cba1e7..496a36d1 100644
--- a/testing/test_core.py
+++ b/tests/test_core.py
@@ -87,7 +87,7 @@ def test(self):
 
 def test_show_entire():
     """
-    pytest testing/test_core.py::test_show_entire
+    pytest tests/test_core.py::test_show_entire
     """
     temp = utils.TempDir()
     dpath = temp.ensure()
@@ -148,7 +148,7 @@ def foo():
 
 def test_freeform_parse_lineno():
     """
-        python ~/code/xdoctest/testing/test_core.py test_freeform_parse_lineno
+        python ~/code/xdoctest/tests/test_core.py test_freeform_parse_lineno
 
     """
     docstr = utils.codeblock(
@@ -210,7 +210,7 @@ def test_freeform_parse_lineno():
 
 def test_collect_module_level():
     """
-    pytest testing/test_core.py::test_collect_module_level -s -vv
+    pytest tests/test_core.py::test_collect_module_level -s -vv
 
     Ignore:
         temp = utils.TempDir()
@@ -246,7 +246,7 @@ def test_collect_module_level():
 
 def test_collect_module_level_singleline():
     """
-    pytest testing/test_core.py::test_collect_module_level
+    pytest tests/test_core.py::test_collect_module_level
 
     Ignore:
         temp = utils.TempDir()
@@ -297,7 +297,7 @@ def get_scales(kpts):
 
 def test_oneliner():
     """
-    python ~/code/xdoctest/testing/test_core.py test_oneliner
+    python ~/code/xdoctest/tests/test_core.py test_oneliner
     """
     with utils.TempDir() as temp:
         dpath = temp.dpath
@@ -330,7 +330,7 @@ def test_delayed_want_pass_cases():
     index of the last part with a success match.
 
     CommandLine:
-        python ~/code/xdoctest/testing/test_core.py test_delayed_want_pass_cases
+        python ~/code/xdoctest/tests/test_core.py test_delayed_want_pass_cases
     """
 
     # Pass Case1:
@@ -366,7 +366,7 @@ def test_delayed_want_pass_cases():
 def test_delayed_want_fail_cases():
     """
     CommandLine:
-        xdoctest -m ~/code/xdoctest/testing/test_core.py test_delayed_want_fail_cases
+        xdoctest -m ~/code/xdoctest/tests/test_core.py test_delayed_want_fail_cases
     """
     # Fail Case4: "more text has not been printed yet"
     status = _test_status(
@@ -423,7 +423,7 @@ def test_indented_grouping():
     string in the indented block).
 
     CommandLine:
-        xdoctest -m ~/code/xdoctest/testing/test_core.py test_indented_grouping
+        xdoctest -m ~/code/xdoctest/tests/test_core.py test_indented_grouping
     """
     from xdoctest.doctest_example import DocTest
     example = DocTest(
@@ -455,7 +455,7 @@ def test_backwards_compat_eval_in_loop():
     Test that changes in 0.10.0 fix backwards compatibility issue.
 
     CommandLine:
-        xdoctest -m ~/code/xdoctest/testing/test_core.py test_backwards_compat_eval_in_loop
+        xdoctest -m ~/code/xdoctest/tests/test_core.py test_backwards_compat_eval_in_loop
     """
     from xdoctest.doctest_example import DocTest
     example = DocTest(
@@ -484,7 +484,7 @@ def test_backwards_compat_eval_in_loop():
 def test_backwards_compat_indent_value():
     """
     CommandLine:
-        xdoctest -m ~/code/xdoctest/testing/test_core.py test_backwards_compat_indent_value
+        xdoctest -m ~/code/xdoctest/tests/test_core.py test_backwards_compat_indent_value
     """
     from xdoctest.doctest_example import DocTest
     example = DocTest(
@@ -502,7 +502,7 @@ def test_backwards_compat_indent_value():
 def test_concise_try_except():
     """
     CommandLine:
-        xdoctest -m ~/code/xdoctest/testing/test_core.py test_concise_try_except
+        xdoctest -m ~/code/xdoctest/tests/test_core.py test_concise_try_except
     """
     from xdoctest.doctest_example import DocTest
     example = DocTest(
@@ -565,7 +565,7 @@ def test_semicolon_line():
 
 
     CommandLine:
-        xdoctest -m ~/code/xdoctest/testing/test_core.py test_concise_exceptions
+        xdoctest -m ~/code/xdoctest/tests/test_core.py test_concise_exceptions
     """
     from xdoctest.doctest_example import DocTest
     example = DocTest(
@@ -603,8 +603,8 @@ def test_semicolon_line():
     """
     CommandLine:
         export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/testing
-        python ~/code/xdoctest/testing/test_core.py zero
-        pytest testing/test_core.py -vv
+        python ~/code/xdoctest/tests/test_core.py zero
+        pytest tests/test_core.py -vv
     """
     import xdoctest  # NOQA
     xdoctest.doctest_module(__file__)
diff --git a/testing/test_directive.py b/tests/test_directive.py
similarity index 89%
rename from testing/test_directive.py
rename to tests/test_directive.py
index abffb2c6..f2df1ebb 100644
--- a/testing/test_directive.py
+++ b/tests/test_directive.py
@@ -6,7 +6,7 @@
 
 def test_inline_skip_directive():
     """
-    pytest testing/test_directive.py::test_inline_skip_directive
+    pytest tests/test_directive.py::test_inline_skip_directive
     """
     string = utils.codeblock(
         '''
@@ -22,7 +22,7 @@ def test_inline_skip_directive():
 
 def test_block_skip_directive():
     """
-    pytest testing/test_directive.py::test_block_skip_directive
+    pytest tests/test_directive.py::test_block_skip_directive
     """
     string = utils.codeblock(
         '''
@@ -39,7 +39,7 @@ def test_multi_requires_directive():
     """
     Test semi-complex case with multiple requirements in a single line
 
-    xdoctest ~/code/xdoctest/testing/test_directive.py test_multi_requires_directive
+    xdoctest ~/code/xdoctest/tests/test_directive.py test_multi_requires_directive
     """
     string = utils.codeblock(
         '''
@@ -93,8 +93,8 @@ def test_directive_syntax_error():
 if __name__ == '__main__':
     """
     CommandLine:
-        python ~/code/xdoctest/testing/test_directive.py
-        pytest ~/code/xdoctest/testing/test_directive.py
+        python ~/code/xdoctest/tests/test_directive.py
+        pytest ~/code/xdoctest/tests/test_directive.py
     """
     import xdoctest
     xdoctest.doctest_module(__file__)
diff --git a/testing/test_doctest_example.py b/tests/test_doctest_example.py
similarity index 85%
rename from testing/test_doctest_example.py
rename to tests/test_doctest_example.py
index 9206bcbe..43e014bb 100644
--- a/testing/test_doctest_example.py
+++ b/tests/test_doctest_example.py
@@ -8,7 +8,7 @@
 
 def test_exit_test_exception():
     """
-    pytest testing/test_doctest_example.py::test_exit_test_exception
+    pytest tests/test_doctest_example.py::test_exit_test_exception
     """
     string = utils.codeblock(
         '''
@@ -24,7 +24,7 @@ def test_exit_test_exception():
 
 def test_failed_assign_want():
     """
-    pytest testing/test_doctest_example.py::test_exit_test_exception
+    pytest tests/test_doctest_example.py::test_exit_test_exception
     """
     string = utils.codeblock(
         '''
@@ -40,7 +40,7 @@ def test_failed_assign_want():
 
 def test_continue_ambiguity():
     """
-    pytest testing/test_doctest_example.py::test_exit_test_exception
+    pytest tests/test_doctest_example.py::test_exit_test_exception
     """
     string = utils.codeblock(
         '''
@@ -59,8 +59,8 @@ def test_continue_ambiguity():
 
 def test_failed_assign_want():
     """
-    pytest testing/test_doctest_example.py::test_exit_test_exception
-    xdoctest ~/code/xdoctest/testing/test_doctest_example.py test_failed_assign_want
+    pytest tests/test_doctest_example.py::test_exit_test_exception
+    xdoctest ~/code/xdoctest/tests/test_doctest_example.py test_failed_assign_want
     """
     string = utils.codeblock(
         '''
@@ -76,7 +76,7 @@ def test_failed_assign_want():
 
 def test_contination_want_ambiguity():
     """
-    xdoctest ~/code/xdoctest/testing/test_doctest_example.py test_contination_want_ambiguity
+    xdoctest ~/code/xdoctest/tests/test_doctest_example.py test_contination_want_ambiguity
     """
     string = utils.codeblock(
         '''
@@ -95,7 +95,7 @@ def test_contination_want_ambiguity():
 
 def test_multiline_list():
     """
-    pytest testing/test_doctest_example.py::test_multiline_list
+    pytest tests/test_doctest_example.py::test_multiline_list
     """
     string = utils.codeblock(
         '''
@@ -131,9 +131,9 @@ def test_failure():
 
 def test_format_src():
     """
-    python testing/test_doctest_example.py test_format_src
+    python tests/test_doctest_example.py test_format_src
 
-    pytest testing/test_doctest_example.py::test_format_src -s -v
+    pytest tests/test_doctest_example.py::test_format_src -s -v
     """
     string = utils.codeblock(
         '''
@@ -158,7 +158,7 @@ def test_format_src():
 
 def test_eval_expr_capture():
     """
-    pytest testing/test_doctest_example.py::test_eval_expr_capture -s
+    pytest tests/test_doctest_example.py::test_eval_expr_capture -s
     """
     docsrc = utils.codeblock(
         '''
@@ -249,8 +249,8 @@ def test_comment():
 
 def test_want_error_msg():
     """
-    python testing/test_doctest_example.py test_want_error_msg
-    pytest testing/test_doctest_example.py::test_want_error_msg
+    python tests/test_doctest_example.py test_want_error_msg
+    pytest tests/test_doctest_example.py::test_want_error_msg
     """
     string = utils.codeblock(
         '''
@@ -265,8 +265,8 @@ def test_want_error_msg():
 
 def test_want_error_msg_failure():
     """
-    python testing/test_doctest_example.py test_want_error_msg_failure
-    pytest testing/test_doctest_example.py::test_want_error_msg_failure
+    python tests/test_doctest_example.py test_want_error_msg_failure
+    pytest tests/test_doctest_example.py::test_want_error_msg_failure
     """
     string = utils.codeblock(
         '''
@@ -285,8 +285,8 @@ def test_want_error_msg_failure():
     """
     CommandLine:
         export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/testing
-        python ~/code/xdoctest/testing/test_doctest_example.py
-        xdoctest ~/code/xdoctest/testing/test_doctest_example.py zero-args
+        python ~/code/xdoctest/tests/test_doctest_example.py
+        xdoctest ~/code/xdoctest/tests/test_doctest_example.py zero-args
     """
     import xdoctest
     xdoctest.doctest_module(__file__)
diff --git a/testing/test_doctest_in_notebook.ipynb b/tests/test_doctest_in_notebook.ipynb
similarity index 100%
rename from testing/test_doctest_in_notebook.ipynb
rename to tests/test_doctest_in_notebook.ipynb
diff --git a/testing/test_dynamic.py b/tests/test_dynamic.py
similarity index 96%
rename from testing/test_dynamic.py
rename to tests/test_dynamic.py
index a9b7e739..465164eb 100644
--- a/testing/test_dynamic.py
+++ b/tests/test_dynamic.py
@@ -86,7 +86,7 @@ def simple_func1():
 def test_parse_dynamic_calldefs():
     """
     CommandLine:
-        python testing/test_dynamic.py test_parse_dynamic_calldefs
+        python tests/test_dynamic.py test_parse_dynamic_calldefs
     """
 
     def subfunc():
@@ -132,7 +132,7 @@ def subfunc():
 def test_defined_by_module():
     """
     CommandLine:
-        python testing/test_dynamic.py test_defined_by_module
+        python tests/test_dynamic.py test_defined_by_module
     """
     module = sys.modules[test_defined_by_module.__module__]
 
@@ -249,8 +249,8 @@ def func1():
 if __name__ == '__main__':
     """
     CommandLine:
-        python testing/test_dynamic.py
-        pytest testing/test_dynamic.py
+        python tests/test_dynamic.py
+        pytest tests/test_dynamic.py
     """
     import xdoctest
     xdoctest.doctest_module(__file__)
diff --git a/testing/test_entry_point.py b/tests/test_entry_point.py
similarity index 95%
rename from testing/test_entry_point.py
rename to tests/test_entry_point.py
index 48013fe3..535d58d5 100644
--- a/testing/test_entry_point.py
+++ b/tests/test_entry_point.py
@@ -74,7 +74,7 @@ def test_xdoc_console_script_exec():
 def test_xdoc_cli_version():
     """
     CommandLine:
-        python -m xdoctest -m ~/code/xdoctest/testing/test_entry_point.py test_xdoc_cli_version
+        python -m xdoctest -m ~/code/xdoctest/tests/test_entry_point.py test_xdoc_cli_version
     """
     import sys
     if sys.platform.startswith('win32'):
@@ -106,7 +106,7 @@ def test_xdoc_cli_version():
 if __name__ == '__main__':
     """
     CommandLine:
-        python ~/code/xdoctest/testing/test_entry_point.py
+        python ~/code/xdoctest/tests/test_entry_point.py
     """
     import xdoctest
     xdoctest.doctest_module(__file__)
diff --git a/testing/test_errors.py b/tests/test_errors.py
similarity index 92%
rename from testing/test_errors.py
rename to tests/test_errors.py
index 01a3c959..e964e029 100644
--- a/testing/test_errors.py
+++ b/tests/test_errors.py
@@ -59,7 +59,7 @@
 def test_parse_syntax_error():
     """
     CommandLine:
-        python testing/test_errors.py test_parse_syntax_error
+        python tests/test_errors.py test_parse_syntax_error
     """
     docstr = utils.codeblock(
         '''
@@ -104,9 +104,9 @@ def test_parse_syntax_error():
 
 def test_runner_syntax_error():
     """
-        python testing/test_errors.py test_runner_syntax_error
+        python tests/test_errors.py test_runner_syntax_error
 
-        xdoctest -m testing/test_errors.py test_runner_syntax_error
+        xdoctest -m tests/test_errors.py test_runner_syntax_error
     """
     source = utils.codeblock(
         r'''
@@ -200,7 +200,7 @@ def test_extract_got_exception():
     Make a repr that fails
 
     CommandLine:
-        xdoctest -m ~/code/xdoctest/testing/test_errors.py test_extract_got_exception
+        xdoctest -m ~/code/xdoctest/tests/test_errors.py test_extract_got_exception
     """
 
     source = utils.codeblock(
@@ -223,11 +223,11 @@ def __repr__(self):
     """
     CommandLine:
         export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/testing
-        python ~/code/xdoctest/testing/test_errors.py
-        pytest ~/code/xdoctest/testing/test_errors.py -s --verbose
+        python ~/code/xdoctest/tests/test_errors.py
+        pytest ~/code/xdoctest/tests/test_errors.py -s --verbose
 
     CommandLine:
-        xdoctest -m ~/code/xdoctest/testing/test_errors.py test_extract_got_exception zero
+        xdoctest -m ~/code/xdoctest/tests/test_errors.py test_extract_got_exception zero
     """
     import xdoctest
     xdoctest.doctest_module(__file__)
diff --git a/tests/test_import.py b/tests/test_import.py
new file mode 100644
index 00000000..16209ab5
--- /dev/null
+++ b/tests/test_import.py
@@ -0,0 +1,2 @@
+def test_import():
+    import xdoctest
\ No newline at end of file
diff --git a/testing/test_limitations.py b/tests/test_limitations.py
similarity index 100%
rename from testing/test_limitations.py
rename to tests/test_limitations.py
diff --git a/testing/test_notebook.py b/tests/test_notebook.py
similarity index 92%
rename from testing/test_notebook.py
rename to tests/test_notebook.py
index 0b1d655e..7fd213b7 100644
--- a/testing/test_notebook.py
+++ b/tests/test_notebook.py
@@ -52,7 +52,7 @@ def demodata_notebook_fpath():
     except NameError:
         # Hack for dev CLI usage
         import os
-        testdir = os.path.expandvars('$HOME/code/xdoctest/testing/')
+        testdir = os.path.expandvars('$HOME/code/xdoctest/tests/')
         assert exists(testdir), 'assuming a specific dev environment'
     notebook_fpath = join(testdir, "notebook_with_doctests.ipynb")
     return notebook_fpath
@@ -60,8 +60,8 @@ def demodata_notebook_fpath():
 
 def test_xdoctest_inside_notebook():
     """
-    xdoctest ~/code/xdoctest/testing/test_notebook.py test_xdoctest_inside_notebook
-    xdoctest testing/test_notebook.py test_xdoctest_inside_notebook
+    xdoctest ~/code/xdoctest/tests/test_notebook.py test_xdoctest_inside_notebook
+    xdoctest tests/test_notebook.py test_xdoctest_inside_notebook
 
     xdoctest notebook_with_doctests.ipynb
     """
diff --git a/testing/test_parser.py b/tests/test_parser.py
similarity index 93%
rename from testing/test_parser.py
rename to tests/test_parser.py
index b3e9c475..5dcbe5d3 100644
--- a/testing/test_parser.py
+++ b/tests/test_parser.py
@@ -12,7 +12,7 @@ def test_final_eval_exec():
     compare its value to the want value.
 
     CommandLine:
-        xdoctest -m ~/code/xdoctest/testing/test_parser.py test_final_eval_exec
+        xdoctest -m ~/code/xdoctest/tests/test_parser.py test_final_eval_exec
     """
     string = utils.codeblock(
         '''
@@ -279,7 +279,7 @@ def test_retain_source():
 
 def test_package_string_tup():
     """
-    pytest testing/test_parser.py::test_package_string_tup
+    pytest tests/test_parser.py::test_package_string_tup
     """
     raw_source_lines = ['>>> "string"']
     raw_want_lines = ['string']
@@ -290,7 +290,7 @@ def test_package_string_tup():
 
 def test_simulate_repl():
     """
-    pytest testing/test_parser.py::test_package_string_tup
+    pytest tests/test_parser.py::test_package_string_tup
     """
     string = utils.codeblock(
         '''
@@ -421,7 +421,7 @@ def test_syntax_error():
 
 def test_nonbalanced_statement():
     """
-    xdoctest ~/code/xdoctest/testing/test_parser.py test_nonbalanced_statement
+    xdoctest ~/code/xdoctest/tests/test_parser.py test_nonbalanced_statement
 
     from xdoctest import static_analysis as static
     lines = ['x = [']
@@ -443,7 +443,7 @@ def test_nonbalanced_statement():
 def test_bad_indent():
     """
     CommandLine:
-        python testing/test_parser.py test_bad_indent
+        python tests/test_parser.py test_bad_indent
     """
     string = utils.codeblock(
         '''
@@ -505,7 +505,7 @@ def test_repl_comment_in_string():
 
 def test_inline_directive():
     """
-        python ~/code/xdoctest/testing/test_parser.py test_inline_directive
+        python ~/code/xdoctest/tests/test_parser.py test_inline_directive
     """
     string = utils.codeblock(
         '''
@@ -551,7 +551,7 @@ def test_inline_directive():
 
 def test_block_directive_nowant1():
     """
-        python ~/code/xdoctest/testing/test_parser.py test_block_directive_nowant1
+        python ~/code/xdoctest/tests/test_parser.py test_block_directive_nowant1
     """
     string = utils.codeblock(
         '''
@@ -575,7 +575,7 @@ def test_block_directive_nowant1():
 
 def test_block_directive_nowant2():
     """
-        python ~/code/xdoctest/testing/test_parser.py test_block_directive_nowant
+        python ~/code/xdoctest/tests/test_parser.py test_block_directive_nowant
     """
     string = utils.codeblock(
         '''
@@ -595,7 +595,7 @@ def test_block_directive_nowant2():
 
 def test_block_directive_want1_assign():
     """
-        python ~/code/xdoctest/testing/test_parser.py test_block_directive_want1
+        python ~/code/xdoctest/tests/test_parser.py test_block_directive_want1
     """
     string = utils.codeblock(
         '''
@@ -619,7 +619,7 @@ def test_block_directive_want1_assign():
 
 def test_block_directive_want1_eval():
     """
-        python ~/code/xdoctest/testing/test_parser.py test_block_directive_want1
+        python ~/code/xdoctest/tests/test_parser.py test_block_directive_want1
     """
     string = utils.codeblock(
         '''
@@ -635,7 +635,7 @@ def test_block_directive_want1_eval():
 
 def test_block_directive_want2_assign():
     """
-        python ~/code/xdoctest/testing/test_parser.py test_block_directive_want2
+        python ~/code/xdoctest/tests/test_parser.py test_block_directive_want2
     """
     string = utils.codeblock(
         '''
@@ -652,7 +652,7 @@ def test_block_directive_want2_assign():
 
 def test_block_directive_want2_eval():
     """
-        python ~/code/xdoctest/testing/test_parser.py test_block_directive_want2_eval
+        python ~/code/xdoctest/tests/test_parser.py test_block_directive_want2_eval
     """
     string = utils.codeblock(
         '''
@@ -677,7 +677,7 @@ def test_block_directive_want2_eval():
 
 def test_block_directive_want2_eval2():
     """
-        python ~/code/xdoctest/testing/test_parser.py test_block_directive_want2_eval
+        python ~/code/xdoctest/tests/test_parser.py test_block_directive_want2_eval
     """
     string = utils.codeblock(
         '''
@@ -726,11 +726,11 @@ def test_gh_issue_25_parsing_failure():
 if __name__ == '__main__':
     """
     CommandLine:
-        python ~/code/xdoctest/testing/test_parser.py --help
-        python ~/code/xdoctest/testing/test_parser.py test_inline_directive
-        python ~/code/xdoctest/testing/test_parser.py zero-all
-        python ~/code/xdoctest/testing/test_parser.py test_gh_issue_25_parsing_failure
-        pytest testing/test_parser.py -vv
+        python ~/code/xdoctest/tests/test_parser.py --help
+        python ~/code/xdoctest/tests/test_parser.py test_inline_directive
+        python ~/code/xdoctest/tests/test_parser.py zero-all
+        python ~/code/xdoctest/tests/test_parser.py test_gh_issue_25_parsing_failure
+        pytest tests/test_parser.py -vv
     """
     import xdoctest
     xdoctest.doctest_module(__file__)
diff --git a/testing/test_plugin.py b/tests/test_plugin.py
similarity index 91%
rename from testing/test_plugin.py
rename to tests/test_plugin.py
index 3f4dd4df..3b5495cc 100644
--- a/testing/test_plugin.py
+++ b/tests/test_plugin.py
@@ -1,8 +1,8 @@
 # encoding: utf-8
 """
-Adapted from the original `pytest/testing/test_doctest.py` module at:
+Adapted from the original `pytest/tests/test_doctest.py` module at:
     https://github.com/pytest-dev/pytest
-    https://github.com/pytest-dev/pytest/blob/main/testing/test_doctest.py
+    https://github.com/pytest-dev/pytest/blob/main/tests/test_doctest.py
 """
 from __future__ import print_function, division, absolute_import, unicode_literals
 import sys
@@ -122,7 +122,7 @@ class TestXDoctest(object):
     def test_collect_testtextfile(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_collect_testtextfile
+            pytest tests/test_plugin.py::TestXDoctest::test_collect_testtextfile
         """
         w = testdir.maketxtfile(whatever="")
         checkfile = testdir.maketxtfile(test_something="""
@@ -144,7 +144,7 @@ def test_collect_testtextfile(self, testdir):
     def test_collect_module_empty(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_collect_module_empty
+            pytest tests/test_plugin.py::TestXDoctest::test_collect_module_empty
         """
         path = testdir.makepyfile(whatever="#")
         for p in (path, testdir.tmpdir):
@@ -155,7 +155,7 @@ def test_collect_module_empty(self, testdir):
     def test_simple_doctestfile(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_simple_doctestfile
+            pytest tests/test_plugin.py::TestXDoctest::test_simple_doctestfile
 
         Ignore:
             >>> import sys
@@ -174,7 +174,7 @@ def test_simple_doctestfile(self, testdir):
     def test_new_pattern(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_new_pattern
+            pytest tests/test_plugin.py::TestXDoctest::test_new_pattern
         """
         p = testdir.maketxtfile(xdoc="""
             >>> x = 1
@@ -188,7 +188,7 @@ def test_multiple_patterns(self, testdir):
         """Test support for multiple --xdoctest-glob arguments (#1255).
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_multiple_patterns
+            pytest tests/test_plugin.py::TestXDoctest::test_multiple_patterns
         """
         testdir.maketxtfile(xdoc="""
             >>> 1
@@ -230,7 +230,7 @@ def test_encoding(self, testdir, test_string, encoding):
             """Test support for xdoctest_encoding ini option.
 
             CommandLine:
-                pytest testing/test_plugin.py::TestXDoctest::test_encoding -s -v
+                pytest tests/test_plugin.py::TestXDoctest::test_encoding -s -v
             """
             testdir.makeini("""
                 [pytest]
@@ -281,7 +281,7 @@ def test_xdoctest_options(self, testdir):
         """Test support for xdoctest_encoding ini option.
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_xdoctest_options
+            pytest tests/test_plugin.py::TestXDoctest::test_xdoctest_options
         """
         # Add command line that skips all doctests by default
         testdir.makeini('''
@@ -302,7 +302,7 @@ def add_one(x):
     def test_doctest_unexpected_exception(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctest_unexpected_exception
+            pytest tests/test_plugin.py::TestXDoctest::test_doctest_unexpected_exception
 
         Ignore:
             >>> import sys
@@ -349,7 +349,7 @@ def test_doctest_property_lineno(self, testdir):
         REASON: Static parsing means we do know this line number.
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctest_property_lineno -v -s
+            pytest tests/test_plugin.py::TestXDoctest::test_doctest_property_lineno -v -s
         """
         testdir.tmpdir.join('hello.py').write(_pytest._code.Source(utils.codeblock(
             """
@@ -379,7 +379,7 @@ def test_doctest_property_lineno_freeform(self, testdir):
         REASON: Static parsing means we do know this line number.
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctest_property_lineno_freeform -v -s
+            pytest tests/test_plugin.py::TestXDoctest::test_doctest_property_lineno_freeform -v -s
         """
         testdir.tmpdir.join('hello.py').write(_pytest._code.Source(utils.codeblock(
             """
@@ -412,7 +412,7 @@ def test_doctest_property_lineno_google(self, testdir):
         REASON: Static parsing means we do know this line number.
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctest_property_lineno_google -v -s
+            pytest tests/test_plugin.py::TestXDoctest::test_doctest_property_lineno_google -v -s
         """
         testdir.tmpdir.join('hello.py').write(_pytest._code.Source(utils.codeblock(
             """
@@ -448,7 +448,7 @@ def test_doctest_property_lineno_google_v2(self, testdir):
         version passed
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctest_property_lineno_google_v2 -v -s
+            pytest tests/test_plugin.py::TestXDoctest::test_doctest_property_lineno_google_v2 -v -s
         """
         testdir.tmpdir.join('hello.py').write(_pytest._code.Source(utils.codeblock(
             """
@@ -483,7 +483,7 @@ def test_docstring_show_entire_doctest(self, testdir):
         # XDOCTEST DOES NOT SHOW NON-SOURCE CONTEXT
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_docstring_show_entire_doctest
+            pytest tests/test_plugin.py::TestXDoctest::test_docstring_show_entire_doctest
         """
         testdir.makepyfile(utils.codeblock(
             '''
@@ -532,7 +532,7 @@ def foo():
     def test_doctest_unex_importerror_only_txt(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctest_unex_importerror_only_txt
+            pytest tests/test_plugin.py::TestXDoctest::test_doctest_unex_importerror_only_txt
         """
         testdir.maketxtfile("""
             >>> import asdalsdkjaslkdjasd
@@ -551,7 +551,7 @@ def test_doctest_unex_importerror_with_module(self, testdir):
             static-parsing baby!
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctest_unex_importerror_with_module
+            pytest tests/test_plugin.py::TestXDoctest::test_doctest_unex_importerror_with_module
         """
         testdir.tmpdir.join("hello.py").write(_pytest._code.Source("""
             import asdalsdkjaslkdjasd
@@ -577,20 +577,20 @@ def test_doctest_unex_importerror_with_module(self, testdir):
     def test_doctestmodule_external_and_issue116(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctestmodule_external_and_issue116
+            pytest tests/test_plugin.py::TestXDoctest::test_doctestmodule_external_and_issue116
 
         Ignore:
-            cd ~/code/xdoctest/testing/data
+            cd ~/code/xdoctest/tests/data
             pytest --xdoctest-modules -p pytester -p no:doctest --xdoctest-nocolor
 
             pip install pytest==3.6.3
-            pytest testing/test_plugin.py::TestXDoctest::test_doctestmodule_external_and_issue116
+            pytest tests/test_plugin.py::TestXDoctest::test_doctestmodule_external_and_issue116
 
             pip install pytest==3.6.4
-            pytest testing/test_plugin.py::TestXDoctest::test_doctestmodule_external_and_issue116
+            pytest tests/test_plugin.py::TestXDoctest::test_doctestmodule_external_and_issue116
 
             pip install pytest==3.7.0
-            pytest testing/test_plugin.py::TestXDoctest::test_doctestmodule_external_and_issue116
+            pytest tests/test_plugin.py::TestXDoctest::test_doctestmodule_external_and_issue116
 
             This was working on pytest-3.6.4
             It now fails on on pytest-3.7.0
@@ -629,7 +629,7 @@ def somefunc():
     def test_txtfile_failing(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_txtfile_failing -s
+            pytest tests/test_plugin.py::TestXDoctest::test_txtfile_failing -s
         """
         p = testdir.maketxtfile("""
             >>> i = 0
@@ -652,7 +652,7 @@ def test_txtfile_failing(self, testdir):
     def test_txtfile_with_fixtures(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_txtfile_with_fixtures
+            pytest tests/test_plugin.py::TestXDoctest::test_txtfile_with_fixtures
         """
         p = testdir.maketxtfile("""
             >>> dir = getfixture('tmpdir')
@@ -665,7 +665,7 @@ def test_txtfile_with_fixtures(self, testdir):
     def test_txtfile_with_usefixtures_in_ini(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_txtfile_with_usefixtures_in_ini
+            pytest tests/test_plugin.py::TestXDoctest::test_txtfile_with_usefixtures_in_ini
         """
         testdir.makeini("""
             [pytest]
@@ -719,7 +719,7 @@ def test_ignored_whitespace_glob(self, testdir):
     def test_contains_unicode(self, testdir):
         """Fix internal error with docstrings containing non-ascii characters.
 
-        pytest testing/test_plugin.py -k test_contains_unicode
+        pytest tests/test_plugin.py -k test_contains_unicode
         """
         testdir.makepyfile(u'''
             # encoding: utf-8
@@ -756,7 +756,7 @@ def test_unicode_doctest_module(self, testdir):
         Test case for issue 2434: DecodeError on Python 2 when xdoctest docstring
         contains non-ascii characters.
 
-        pytest -rsxX -p pytester testing/test_plugin.py::TestXDoctest::test_unicode_doctest_module
+        pytest -rsxX -p pytester tests/test_plugin.py::TestXDoctest::test_unicode_doctest_module
 
         """
         p = testdir.makepyfile(test_unicode_doctest_module="""
@@ -775,7 +775,7 @@ def fix_bad_unicode(text):
 
     def test_xdoctest_multiline_list(self, testdir):
         """
-        pytest testing/test_plugin.py -k test_xdoctest_multiline_list
+        pytest tests/test_plugin.py -k test_xdoctest_multiline_list
         """
         p = testdir.maketxtfile(test_xdoctest_multiline_string="""
             .. xdoctest::
@@ -790,7 +790,7 @@ def test_xdoctest_multiline_list(self, testdir):
 
     def test_xdoctest_multiline_string(self, testdir):
         """
-        pytest -rsxX -p pytester testing/test_plugin.py::TestXDoctest::test_xdoctest_multiline_string
+        pytest -rsxX -p pytester tests/test_plugin.py::TestXDoctest::test_xdoctest_multiline_string
         """
         import textwrap
         p = testdir.maketxtfile(test_xdoctest_multiline_string=textwrap.dedent(
@@ -825,7 +825,7 @@ def test_xdoctest_multiline_string(self, testdir):
     def test_xdoctest_trycatch(self, testdir):
         """
         CommandLine:
-            pytest -rsxX -p pytester testing/test_plugin.py::TestXDoctest::test_xdoctest_trycatch
+            pytest -rsxX -p pytester tests/test_plugin.py::TestXDoctest::test_xdoctest_trycatch
         """
         p = testdir.maketxtfile(test_xdoctest_multiline_string="""
             .. xdoctest::
@@ -856,7 +856,7 @@ def test_xdoctest_trycatch(self, testdir):
     def test_xdoctest_functions(self, testdir):
         """
         CommandLine:
-            pytest -rsxX -p pytester testing/test_plugin.py::TestXDoctest::test_xdoctest_functions
+            pytest -rsxX -p pytester tests/test_plugin.py::TestXDoctest::test_xdoctest_functions
         """
         p = testdir.maketxtfile(test_xdoctest_multiline_string="""
             .. xdoctest::
@@ -880,7 +880,7 @@ def test_stdout_capture_no(self, testdir):
         """
         Test for xdoctest#3
 
-        pytest -rsxX -p pytester testing/test_plugin.py::TestXDoctest::test_stdout_capture_no
+        pytest -rsxX -p pytester tests/test_plugin.py::TestXDoctest::test_stdout_capture_no
 
         Ignore:
             >>> import sys
@@ -906,7 +906,7 @@ def test_stdout_capture_yes(self, testdir):
         """
         Test for xdoctest#3
 
-        pytest -rsxX -p pytester testing/test_plugin.py::TestXDoctest::test_stdout_capture_yes
+        pytest -rsxX -p pytester tests/test_plugin.py::TestXDoctest::test_stdout_capture_yes
         """
         p = testdir.makepyfile(test_unicode_doctest_module='''
             def foo():
@@ -929,7 +929,7 @@ class TestXDoctestModuleLevel(object):
     def test_doctestmodule(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctestModuleLevel::test_doctestmodule
+            pytest tests/test_plugin.py::TestXDoctestModuleLevel::test_doctestmodule
 
         Ignore:
             >>> import sys
@@ -954,7 +954,7 @@ def test_doctestmodule(self, testdir):
     def test_collect_module_single_modulelevel_doctest(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctestModuleLevel::test_collect_module_single_modulelevel_doctest
+            pytest tests/test_plugin.py::TestXDoctestModuleLevel::test_collect_module_single_modulelevel_doctest
 
         Ignore:
             >>> import sys
@@ -987,7 +987,7 @@ def my_func():
     def test_collect_module_two_doctest_no_modulelevel(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctestModuleLevel::test_collect_module_two_doctest_no_modulelevel
+            pytest tests/test_plugin.py::TestXDoctestModuleLevel::test_collect_module_two_doctest_no_modulelevel
 
         Ignore:
             >>> import sys
@@ -1119,7 +1119,7 @@ class TestXDoctestSkips(object):
     the tests should be SKIPPED rather than PASSED. (#957)
 
     CommandLine
-        pytest testing/test_plugin.py::TestXDoctestSkips
+        pytest tests/test_plugin.py::TestXDoctestSkips
     """
 
     def test_xdoctest_skips_diabled(self, testdir):
@@ -1155,7 +1155,7 @@ def makeit(xdoctest):
     def test_one_skipped_passed(self, testdir, makedoctest):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctestSkips::test_one_skipped_passed
+            pytest tests/test_plugin.py::TestXDoctestSkips::test_one_skipped_passed
         """
         makedoctest("""
             >>> 1 + 1  # xdoctest: +SKIP
@@ -1169,7 +1169,7 @@ def test_one_skipped_passed(self, testdir, makedoctest):
     def test_one_skipped_failed(self, testdir, makedoctest):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctestSkips::test_one_skipped_failed
+            pytest tests/test_plugin.py::TestXDoctestSkips::test_one_skipped_failed
         """
         makedoctest("""
             >>> 1 + 1  # xdoctest: +SKIP
@@ -1183,7 +1183,7 @@ def test_one_skipped_failed(self, testdir, makedoctest):
     def test_all_skipped(self, testdir, makedoctest):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctestSkips::test_all_skipped
+            pytest tests/test_plugin.py::TestXDoctestSkips::test_all_skipped
         """
         makedoctest("""
             >>> 1 + 1  # xdoctest: +SKIP
@@ -1200,7 +1200,7 @@ def test_all_skipped(self, testdir, makedoctest):
     def test_all_skipped_global(self, testdir, makedoctest):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctestSkips::test_all_skipped_global
+            pytest tests/test_plugin.py::TestXDoctestSkips::test_all_skipped_global
         """
         # Test new global directive added in xdoctest
         makedoctest("""
@@ -1261,7 +1261,7 @@ def test_fixture_scopes(self, testdir, scope, enable_doctest):
         """Test that auto-use fixtures work properly with xdoctest modules.
         See #1057 and #1100.
 
-        pytest testing/test_plugin.py -k test_fixture_scopes
+        pytest tests/test_plugin.py -k test_fixture_scopes
         """
         testdir.makeconftest('''
             import pytest
@@ -1293,7 +1293,7 @@ def test_fixture_module_doctest_scopes(self, testdir, scope, autouse,
         """Test that auto-use fixtures work properly with xdoctest files.
         See #1057 and #1100.
 
-        pytest testing/test_plugin.py -k test_fixture_module_doctest_scopes
+        pytest tests/test_plugin.py -k test_fixture_module_doctest_scopes
         """
         testdir.makeconftest('''
             import pytest
@@ -1351,7 +1351,7 @@ class TestXDoctestNamespaceFixture(object):
     FIXME: These dont work because xdoctest does not support running with
     fixtures yet.
 
-    pytest testing/test_plugin.py::TestXDoctestNamespaceFixture
+    pytest tests/test_plugin.py::TestXDoctestNamespaceFixture
     """
 
     SCOPES = ['module', 'session', 'class', 'function']
@@ -1383,7 +1383,7 @@ def test_namespace_pyfile(self, testdir, scope):
         Check that inserting something into the namespace works in a
         simple Python file docstring xdoctest
 
-        pytest testing/test_plugin.py::TestXDoctestNamespaceFixture::test_namespace_pyfile
+        pytest tests/test_plugin.py::TestXDoctestNamespaceFixture::test_namespace_pyfile
         """
         testdir.makeconftest("""
             import pytest
@@ -1427,7 +1427,7 @@ def foo():
     @pytest.mark.parametrize('format', ['udiff', 'UDIFF', 'uDiFf'])
     def test_doctest_report_udiff(self, testdir, format):
         """
-        pytest testing/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_udiff
+        pytest tests/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_udiff
         """
         result = self._run_doctest_report(testdir, format)
         result.stdout.fnmatch_lines([
@@ -1439,7 +1439,7 @@ def test_doctest_report_udiff(self, testdir, format):
 
     def test_doctest_report_cdiff(self, testdir):
         """
-        pytest testing/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_cdiff
+        pytest tests/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_cdiff
         """
         result = self._run_doctest_report(testdir, 'cdiff')
         result.stdout.fnmatch_lines([
@@ -1456,7 +1456,7 @@ def test_doctest_report_cdiff(self, testdir):
 
     def test_doctest_report_ndiff(self, testdir):
         """
-        pytest testing/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_ndiff
+        pytest tests/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_ndiff
         """
         result = self._run_doctest_report(testdir, 'ndiff')
         result.stdout.fnmatch_lines([
@@ -1472,7 +1472,7 @@ def test_doctest_report_ndiff(self, testdir):
     @pytest.mark.parametrize('format', ['none', 'only_first_failure'])
     def test_doctest_report_none_or_only_first_failure(self, testdir, format):
         """
-        pytest testing/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_none_or_only_first_failure
+        pytest tests/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_none_or_only_first_failure
         """
         result = self._run_doctest_report(testdir, format)
         result.stdout.fnmatch_lines([
@@ -1490,7 +1490,7 @@ def test_doctest_report_none_or_only_first_failure(self, testdir, format):
 
     def test_doctest_report_invalid(self, testdir):
         """
-        pytest testing/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_invalid
+        pytest tests/test_plugin.py::TestXDoctestReportingOption::test_doctest_report_invalid
         """
         result = self._run_doctest_report(testdir, 'obviously_invalid_format')
         result.stderr.fnmatch_lines([
@@ -1507,7 +1507,7 @@ def test_docstring_context_around_error(self, testdir):
         # XDOCTEST DOES NOT SHOW NON-SOURCE CONTEXT
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_docstring_context_around_error
+            pytest tests/test_plugin.py::TestXDoctest::test_docstring_context_around_error
         """
         testdir.makepyfile('''
             def foo():
@@ -1551,7 +1551,7 @@ def test_doctest_linedata_missing(self, testdir):
         REASON: Static parsing means we do know this line number.
 
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctest_linedata_missing
+            pytest tests/test_plugin.py::TestXDoctest::test_doctest_linedata_missing
         """
         testdir.tmpdir.join('hello.py').write(_pytest._code.Source("""
             class Fun(object):
@@ -1610,7 +1610,7 @@ def another():
     def test_doctestmodule_two_tests_one_fail(self, testdir):
         """
         CommandLine:
-            pytest testing/test_plugin.py::TestXDoctest::test_doctestmodule_two_tests_one_fail
+            pytest tests/test_plugin.py::TestXDoctest::test_doctestmodule_two_tests_one_fail
         """
         p = testdir.makepyfile("""
             class MyClass(object):
diff --git a/testing/test_pytest_cli.py b/tests/test_pytest_cli.py
similarity index 97%
rename from testing/test_pytest_cli.py
rename to tests/test_pytest_cli.py
index c187d7aa..8fbff6ee 100644
--- a/testing/test_pytest_cli.py
+++ b/tests/test_pytest_cli.py
@@ -46,7 +46,7 @@ def test_simple_pytest_import_error_cli():
     dev/0.15.7
 
     CommandLine:
-        xdoctest ~/code/xdoctest/testing/test_pytest_cli.py test_simple_pytest_import_error_cli
+        xdoctest ~/code/xdoctest/tests/test_pytest_cli.py test_simple_pytest_import_error_cli
     """
     module_text = utils.codeblock(
         '''
diff --git a/testing/test_runner.py b/tests/test_runner.py
similarity index 92%
rename from testing/test_runner.py
rename to tests/test_runner.py
index b0eb6712..98f4a79c 100644
--- a/testing/test_runner.py
+++ b/tests/test_runner.py
@@ -5,7 +5,7 @@
 
 def test_zero_args():
     """
-    python testing/test_runner.py test_zero_args
+    python tests/test_runner.py test_zero_args
     """
     from xdoctest import runner
 
@@ -142,8 +142,8 @@ def foo():
 
 def test_all_disabled():
     """
-    pytest testing/test_runner.py::test_all_disabled -s -vv
-    python testing/test_runner.py test_all_disabled
+    pytest tests/test_runner.py::test_all_disabled -s -vv
+    python tests/test_runner.py test_all_disabled
     """
     from xdoctest import runner
 
@@ -186,9 +186,9 @@ def bar():
 
 def test_runner_failures():
     """
-    python testing/test_runner.py  test_runner_failures
-    pytest testing/test_runner.py::test_runner_failures -s
-    pytest testing/test_runner.py::test_all_disabled -s
+    python tests/test_runner.py  test_runner_failures
+    pytest tests/test_runner.py::test_runner_failures -s
+    pytest tests/test_runner.py::test_all_disabled -s
     """
     from xdoctest import runner
 
@@ -253,7 +253,7 @@ def test4():
 
 def test_run_zero_arg():
     """
-    pytest testing/test_runner.py::test_run_zero_arg -s
+    pytest tests/test_runner.py::test_run_zero_arg -s
     """
     from xdoctest import runner
 
@@ -289,7 +289,7 @@ def zero_arg_print():
 
 def test_parse_cmdline():
     """
-    pytest testing/test_runner.py::test_parse_cmdline -s
+    pytest tests/test_runner.py::test_parse_cmdline -s
     """
     from xdoctest import runner
     # sys.argv could be anything, so just run this for coverage to make sure it doesnt crash
@@ -302,7 +302,7 @@ def test_parse_cmdline():
 
 def test_runner_config():
     """
-    pytest testing/test_runner.py::test_runner_config -s
+    pytest tests/test_runner.py::test_runner_config -s
     """
     from xdoctest import runner
 
@@ -334,7 +334,7 @@ def foo():
 
 def test_global_exec():
     """
-    pytest testing/test_runner.py::test_global_exec -s
+    pytest tests/test_runner.py::test_global_exec -s
     """
     from xdoctest import runner
 
@@ -368,7 +368,7 @@ def test_hack_the_sys_argv():
     """
     Tests hacky solution to issue #76
 
-    pytest testing/test_runner.py::test_global_exec -s
+    pytest tests/test_runner.py::test_global_exec -s
 
     References:
         https://github.com/Erotemic/xdoctest/issues/76
@@ -413,9 +413,9 @@ def foo():
 if __name__ == '__main__':
     """
     CommandLine:
-        pytest testing/test_runner.py -s
-        pytest testing/test_runner.py -s
-        python testing/test_runner.py test_zero_args
+        pytest tests/test_runner.py -s
+        pytest tests/test_runner.py -s
+        python tests/test_runner.py test_zero_args
     """
     # import pytest
     # pytest.main([__file__])
diff --git a/testing/test_static.py b/tests/test_static.py
similarity index 96%
rename from testing/test_static.py
rename to tests/test_static.py
index b7a955d8..98b11e77 100644
--- a/testing/test_static.py
+++ b/tests/test_static.py
@@ -132,8 +132,8 @@ def decor4(self):   # 37
 if __name__ == '__main__':
     """
     CommandLine:
-        python -B %HOME%/code/xdoctest/testing/test_static.py all
-        pytest ~/code/xdoctest/testing/test_static.py
+        python -B %HOME%/code/xdoctest/tests/test_static.py all
+        pytest ~/code/xdoctest/tests/test_static.py
     """
     import xdoctest
     xdoctest.doctest_module(__file__)
diff --git a/testing/test_traceback.py b/tests/test_traceback.py
similarity index 87%
rename from testing/test_traceback.py
rename to tests/test_traceback.py
index 95959d59..c92665e4 100644
--- a/testing/test_traceback.py
+++ b/tests/test_traceback.py
@@ -27,7 +27,7 @@ def func(a):
 
 def test_fail_call_twofunc():
     """
-        python ~/code/xdoctest/testing/test_traceback.py test_fail_call_twofunc
+        python ~/code/xdoctest/tests/test_traceback.py test_fail_call_twofunc
 
     """
     import warnings
@@ -58,7 +58,7 @@ def func2(a):
 
 def test_fail_inside_twofunc():
     """
-        python ~/code/xdoctest/testing/test_traceback.py test_fail_inside_twofunc
+        python ~/code/xdoctest/tests/test_traceback.py test_fail_inside_twofunc
 
     """
     import warnings
@@ -92,7 +92,7 @@ def func2(a):
 
 def test_fail_inside_onefunc():
     """
-        python ~/code/xdoctest/testing/test_traceback.py test_fail_inside_onefunc
+        python ~/code/xdoctest/tests/test_traceback.py test_fail_inside_onefunc
 
     """
     text = _run_case(utils.codeblock(
@@ -117,7 +117,7 @@ def func(a):
 def test_failure_linenos():
     """
     Example:
-        python ~/code/xdoctest/testing/test_linenos.py test_failure_linenos
+        python ~/code/xdoctest/tests/test_linenos.py test_failure_linenos
 
     Example:
         >>> test_failure_linenos()
@@ -167,14 +167,14 @@ def func(a):
 
 SeeAlso:
     # This plugin tests also checks line numbers. Make sure we dont break it
-    pytest testing/test_plugin.py::TestXDoctest::test_doctest_property_lineno -v -s
+    pytest tests/test_plugin.py::TestXDoctest::test_doctest_property_lineno -v -s
 
 """
 
 
 def test_lineno_failcase_gotwant():
     """
-        python ~/code/xdoctest/testing/test_linenos.py test_lineno_failcase_gotwant
+        python ~/code/xdoctest/tests/test_linenos.py test_lineno_failcase_gotwant
 
     """
     text = _run_case(utils.codeblock(
@@ -195,8 +195,8 @@ def func(a):
 
 def test_lineno_failcase_called_code():
     """
-        python ~/code/xdoctest/testing/test_linenos.py test_lineno_failcase_called_code
-        python ~/code/xdoctest/testing/test_linenos.py
+        python ~/code/xdoctest/tests/test_linenos.py test_lineno_failcase_called_code
+        python ~/code/xdoctest/tests/test_linenos.py
 
     """
     text = _run_case(utils.codeblock(
@@ -227,7 +227,7 @@ def nested_failure(a):
 
 def test_lineno_failcase_doctest_code():
     """
-        python ~/code/xdoctest/testing/test_linenos.py test_lineno_failcase_doctest_code
+        python ~/code/xdoctest/tests/test_linenos.py test_lineno_failcase_doctest_code
 
     """
     text = _run_case(utils.codeblock(
@@ -260,8 +260,8 @@ def func(a):
     """
     CommandLine:
         export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/testing
-        python ~/code/xdoctest/testing/test_traceback.py
-        pytest ~/code/xdoctest/testing/test_traceback.py -s
+        python ~/code/xdoctest/tests/test_traceback.py
+        pytest ~/code/xdoctest/tests/test_traceback.py -s
     """
     import xdoctest
     xdoctest.doctest_module(__file__)
diff --git a/xdoctest/checker.py b/xdoctest/checker.py
index 6a5c9921..2be424a2 100644
--- a/xdoctest/checker.py
+++ b/xdoctest/checker.py
@@ -105,8 +105,8 @@ def check_got_vs_want(want, got_stdout, got_eval=constants.NOT_EVALED,
                     got = got_stdout
     if not flag:
         msg = 'got differs with doctest want'
-        ex = GotWantException(msg, got, want)
-        raise ex
+        exp = GotWantException(msg, got, want)
+        raise exp
     return flag
 
 
diff --git a/xdoctest/constants.py b/xdoctest/constants.py
index 4bbc0418..27be088b 100644
--- a/xdoctest/constants.py
+++ b/xdoctest/constants.py
@@ -4,30 +4,32 @@
 """
 from __future__ import print_function, division, absolute_import, unicode_literals
 
-if False:
-    NOT_EVALED = object()  # nocover
-else:
-    # Create the most singleton object ever to avoid reload issues
-    # see ubelt.NoParam for details on how this works
-    class _NOT_EVAL_TYPE(object):
-        def __new__(cls):
-            return NOT_EVALED
-        def __reduce__(self):
-            return (_NOT_EVAL_TYPE, ())
-        def __copy__(self):
-            return NOT_EVALED
-        def __deepcopy__(self, memo):
-            return NOT_EVALED
-        def __call__(self, default):
-            pass
-        def __str__(cls):
-            return '<NOT_EVALED>'
-        def __repr__(cls):
-            return '<NOT_EVALED>'
-        def __bool__(self):
-            return False
-        __nonzero__ = __bool__
-    try:
-        NOT_EVALED  # pragma: no cover
-    except NameError:  # pragma: no cover
-        NOT_EVALED = object.__new__(_NOT_EVAL_TYPE)  # pragma: no cover
+# if False:
+#     NOT_EVALED = object()  # nocover
+# else:
+
+
+# Create the most singleton object ever to avoid reload issues
+# see ubelt.NoParam for details on how this works
+class _NOT_EVAL_TYPE(object):
+    def __new__(cls):
+        return NOT_EVALED
+    def __reduce__(self):
+        return (_NOT_EVAL_TYPE, ())
+    def __copy__(self):
+        return NOT_EVALED
+    def __deepcopy__(self, memo):
+        return NOT_EVALED
+    def __call__(self, default):
+        pass
+    def __str__(cls):
+        return '<NOT_EVALED>'
+    def __repr__(cls):
+        return '<NOT_EVALED>'
+    def __bool__(self):
+        return False
+    __nonzero__ = __bool__
+try:
+    NOT_EVALED  # pragma: no cover
+except NameError:  # pragma: no cover
+    NOT_EVALED = object.__new__(_NOT_EVAL_TYPE)  # pragma: no cover
diff --git a/xdoctest/demo.py b/xdoctest/demo.py
index 31c860da..2f29b001 100644
--- a/xdoctest/demo.py
+++ b/xdoctest/demo.py
@@ -13,13 +13,13 @@
 def myfunc():
     """
     Demonstrates how to write a doctest.
-    Prefix with `>>>` and ideally place in an `Example:` block.
+    Prefix with ``>>>`` and ideally place in an `Example:` block.
     You can also change Example, Ignore will
-    Prefix with `>>>` and ideally place in an `Example:` block.
+    Prefix with ``>>>`` and ideally place in an `Example:` block.
 
     CommandLine:
         # it would be nice if sphinx.ext.napoleon could handle this
-        xdoctest -m ~/code/xdoctest/xdoctest/demo.py myfunc
+        xdoctest -m xdoctest.demo myfunc
 
     Example:
         >>> result = myfunc()
@@ -50,8 +50,8 @@ def __init__(self, *args, **kw):
     def demo(cls, **kw):
         """
         CommandLine:
-            xdoctest -m ~/code/xdoctest/xdoctest/demo.py MyClass.demo
-            xdoctest -m ~/code/xdoctest/xdoctest/demo.py MyClass.demo --say
+            xdoctest -m xdoctest.demo MyClass.demo
+            xdoctest -m xdoctest.demo MyClass.demo --say
 
         Example:
             >>> print('starting my doctest')
@@ -61,17 +61,18 @@ def demo(cls, **kw):
         """
         return MyClass(['spam'] * 42, ['eggs'],  **kw)
 
+    @staticmethod
     def always_fails():
         """
         CommandLine:
-            xdoctest -m ~/code/xdoctest/xdoctest/demo.py MyClass.always_fails
-            xdoctest -m ~/code/xdoctest/xdoctest/demo.py MyClass.always_fails --fail
-            xdoctest -m ~/code/xdoctest/xdoctest/demo.py MyClass.always_fails --fail --really
-
-            xdoctest -m ~/code/xdoctest/xdoctest/demo.py MyClass.always_fails:0 --fail
-            xdoctest -m ~/code/xdoctest/xdoctest/demo.py MyClass.always_fails:1 --fail
-            xdoctest -m ~/code/xdoctest/xdoctest/demo.py MyClass.always_fails:2 --fail
-            xdoctest -m ~/code/xdoctest/xdoctest/demo.py MyClass.always_fails:3 --fail --really
+            xdoctest -m xdoctest.demo MyClass.always_fails
+            xdoctest -m xdoctest.demo MyClass.always_fails --fail
+            xdoctest -m xdoctest.demo MyClass.always_fails --fail --really
+
+            xdoctest -m xdoctest.demo MyClass.always_fails:0 --fail
+            xdoctest -m xdoctest.demo MyClass.always_fails:1 --fail
+            xdoctest -m xdoctest.demo MyClass.always_fails:2 --fail
+            xdoctest -m xdoctest.demo MyClass.always_fails:3 --fail --really
 
         Example:
             >>> # xdoctest: +REQUIRES(--fail)
diff --git a/xdoctest/dynamic_analysis.py b/xdoctest/dynamic_analysis.py
index 26a7b736..96b40383 100644
--- a/xdoctest/dynamic_analysis.py
+++ b/xdoctest/dynamic_analysis.py
@@ -49,8 +49,8 @@ def parse_dynamic_calldefs(modpath_or_module):
         modpath = modpath_or_module
         if modpath.endswith('.ipynb'):
             """
-            modpath = ub.expandpath("~/code/xdoctest/testing/notebook_with_doctests.ipynb")
-            xdoctest ~/code/xdoctest/testing/notebook_with_doctests.ipynb
+            modpath = ub.expandpath("~/code/xdoctest/tests/notebook_with_doctests.ipynb")
+            xdoctest ~/code/xdoctest/tests/notebook_with_doctests.ipynb
             """
             from xdoctest.utils import util_notebook
             module = util_notebook.import_notebook_from_path(modpath)
diff --git a/xdoctest/plugin.py b/xdoctest/plugin.py
index 87cc0738..ce2339a0 100644
--- a/xdoctest/plugin.py
+++ b/xdoctest/plugin.py
@@ -19,9 +19,13 @@
 import pytest
 from _pytest._code import code
 from _pytest import fixtures
-from distutils.version import LooseVersion
-# import traceback
 
+try:
+    from packaging.version import parse as parse_version
+    _PYTEST_IS_GE_620 = parse_version(pytest.__version__) >= parse_version('6.2.0')
+except ImportError:
+    from distutils.version import LooseVersion
+    _PYTEST_IS_GE_620 = LooseVersion(pytest.__version__) >= LooseVersion('6.2.0')
 
 # def print(text):
 #     """ Hack so we can get stdout when debugging the plugin file """
@@ -112,8 +116,8 @@ def str_lower(x):
 
 
 if pytest.__version__ < '7.':
-    def pytest_collect_file(path, parent):
-        return _pytest_collect_file(path, parent, fspath=path)
+    def pytest_collect_file(file_path, parent):
+        return _pytest_collect_file(file_path, parent, fspath=file_path)
 
     def _suffix(path):
         return path.ext
@@ -289,10 +293,6 @@ def collect(self):
                 yield XDoctestItem(name, self, example)
 
 
-_PYTEST_IS_GE_620 = LooseVersion(pytest.__version__) >= LooseVersion('6.2.0')
-# _PYTEST_IS_GE_620 = 0
-
-
 def _setup_fixtures(xdoctest_item):
     """
     Used by XDoctestTextfile and XDoctestItem to setup fixture information.
diff --git a/xdoctest/utils/util_path.py b/xdoctest/utils/util_path.py
index 88ff226b..e5dafcf0 100644
--- a/xdoctest/utils/util_path.py
+++ b/xdoctest/utils/util_path.py
@@ -3,10 +3,10 @@
 Utilities related to filesystem paths
 """
 from __future__ import print_function, division, absolute_import, unicode_literals
+import os
 from os.path import exists
 from os.path import join
 from os.path import normpath
-from os.path import os
 import shutil
 
 

From 0492c2ed9506e24333bd1926d496af4098b25df7 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 18:28:33 -0400
Subject: [PATCH 13/38] Update to modern deprecation func

---
 .gitignore                         |   2 +
 MANIFEST.in                        |   4 +-
 pyproject.toml                     |  30 ++++++
 requirements/docs.txt              |   8 ++
 run_linter.sh                      |   2 +
 tests/test_core.py                 |   2 +-
 tests/test_doctest_example.py      |  19 +---
 tests/test_errors.py               |   2 +-
 tests/test_plugin.py               |  16 ++--
 tests/test_traceback.py            |   4 +-
 xdoctest/__init__.py               |   5 +-
 xdoctest/core.py                   |   4 +-
 xdoctest/directive.py              |   4 +-
 xdoctest/static_analysis.py        |   2 +-
 xdoctest/utils/util_deprecation.py | 147 ++++++++++++++++++++---------
 xdoctest/utils/util_stream.py      |   2 +-
 16 files changed, 169 insertions(+), 84 deletions(-)
 create mode 100644 pyproject.toml
 create mode 100644 requirements/docs.txt
 create mode 100644 run_linter.sh

diff --git a/.gitignore b/.gitignore
index 2645ea27..8f2b0f54 100644
--- a/.gitignore
+++ b/.gitignore
@@ -94,3 +94,5 @@ dev/*.pgp
 
 requirements-strict.txt
 requirements-strict
+
+tests/pybind11_test/_skbuild/
diff --git a/MANIFEST.in b/MANIFEST.in
index 98fb751b..99d9d60f 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -10,5 +10,5 @@ recursive-include docs *.rst
 recursive-include docs *.txt
 recursive-include docs Makefile
 recursive-include requirements *.txt
-recursive-include testing *.py
-recursive-include testing *.ipynb
+recursive-include tests *.py
+recursive-include tests *.ipynb
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 00000000..908c624f
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,30 @@
+[build-system]
+requires = [ "setuptools>=41.0.1",]
+
+[tool.mypy]
+ignore_missing_imports = true
+
+[tool.xcookie]
+tags = [ "erotemic", "github", "purepy",]
+mod_name = "xdoctest"
+repo_name = "xdoctest"
+rel_mod_parent_dpath = "."
+os = [ "all", "win", "linux", "osx",]
+min_python = 2.7
+author = "Jon Crall"
+author_email = "erotemic@gmail.com"
+description = "A module cut from xcookie"
+license = "Apache 2"
+
+[tool.pytest.ini_options]
+addopts = "-p no:doctest --xdoctest --xdoctest-style=google --ignore-glob=setup.py --ignore-glob=dev"
+norecursedirs = ".git ignore build __pycache__ dev _skbuild"
+filterwarnings = [ "default", "ignore:.*No cfgstr given in Cacher constructor or call.*:Warning", "ignore:.*Define the __nice__ method for.*:Warning", "ignore:.*private pytest class or function.*:Warning",]
+
+[tool.coverage.run]
+branch = true
+source = ["xdoctest"]
+
+[tool.coverage.report]
+exclude_lines = [ "pragma: no cover", ".*  # pragma: no cover", ".*  # nocover", "def __repr__", "raise AssertionError", "raise NotImplementedError", "if 0:", "if trace is not None", "verbose = .*", "^ *raise", "^ *pass *$", "if _debug:", "if __name__ == .__main__.:", ".*if six.PY2:",]
+omit = [ "xdoctest/__main__.py", "*/setup.py",]
diff --git a/requirements/docs.txt b/requirements/docs.txt
new file mode 100644
index 00000000..57d0dabc
--- /dev/null
+++ b/requirements/docs.txt
@@ -0,0 +1,8 @@
+sphinx >= 5.0.1
+sphinx-autobuild >= 2021.3.14
+sphinx_rtd_theme >= 1.0.0
+sphinxcontrib-napoleon >= 0.7
+sphinx-autoapi >= 1.8.4
+Pygments >= 2.9.0
+myst_parser >= 0.18.0
+sphinx-reredirects >= 0.0.1
diff --git a/run_linter.sh b/run_linter.sh
new file mode 100644
index 00000000..0787f081
--- /dev/null
+++ b/run_linter.sh
@@ -0,0 +1,2 @@
+#!/bin/bash
+flake8 ./xdoctest --count --select=E9,F63,F7,F82 --show-source --statistics
diff --git a/tests/test_core.py b/tests/test_core.py
index 496a36d1..0baccc94 100644
--- a/tests/test_core.py
+++ b/tests/test_core.py
@@ -602,7 +602,7 @@ def test_semicolon_line():
 if __name__ == '__main__':
     """
     CommandLine:
-        export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/testing
+        export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/tests
         python ~/code/xdoctest/tests/test_core.py zero
         pytest tests/test_core.py -vv
     """
diff --git a/tests/test_doctest_example.py b/tests/test_doctest_example.py
index 43e014bb..de67aa6e 100644
--- a/tests/test_doctest_example.py
+++ b/tests/test_doctest_example.py
@@ -57,23 +57,6 @@ def test_continue_ambiguity():
     assert result['passed']
 
 
-def test_failed_assign_want():
-    """
-    pytest tests/test_doctest_example.py::test_exit_test_exception
-    xdoctest ~/code/xdoctest/tests/test_doctest_example.py test_failed_assign_want
-    """
-    string = utils.codeblock(
-        '''
-        >>> name = 'foo'
-        'anything'
-        ''')
-    self = doctest_example.DocTest(docsrc=string)
-    result = self.run(on_error='return', verbose=0)
-    assert result['failed']
-    fail_text = '\n'.join(self.repr_failure())
-    assert 'Got nothing' in fail_text
-
-
 def test_contination_want_ambiguity():
     """
     xdoctest ~/code/xdoctest/tests/test_doctest_example.py test_contination_want_ambiguity
@@ -284,7 +267,7 @@ def test_want_error_msg_failure():
 if __name__ == '__main__':
     """
     CommandLine:
-        export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/testing
+        export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/tests
         python ~/code/xdoctest/tests/test_doctest_example.py
         xdoctest ~/code/xdoctest/tests/test_doctest_example.py zero-args
     """
diff --git a/tests/test_errors.py b/tests/test_errors.py
index e964e029..866676c8 100644
--- a/tests/test_errors.py
+++ b/tests/test_errors.py
@@ -222,7 +222,7 @@ def __repr__(self):
 if __name__ == '__main__':
     """
     CommandLine:
-        export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/testing
+        export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/tests
         python ~/code/xdoctest/tests/test_errors.py
         pytest ~/code/xdoctest/tests/test_errors.py -s --verbose
 
diff --git a/tests/test_plugin.py b/tests/test_plugin.py
index 3b5495cc..cd69486a 100644
--- a/tests/test_plugin.py
+++ b/tests/test_plugin.py
@@ -51,7 +51,7 @@ def explicit_testdir():
         "
     Ignore:
         >>> import sys
-        >>> sys.path.append('/home/joncrall/code/xdoctest/testing')
+        >>> sys.path.append('/home/joncrall/code/xdoctest/tests')
         >>> from test_plugin import *
     """
     # modpath = _modname_to_modpath_backup('pytest')
@@ -159,7 +159,7 @@ def test_simple_doctestfile(self, testdir):
 
         Ignore:
             >>> import sys
-            >>> sys.path.append('/home/joncrall/code/xdoctest/testing')
+            >>> sys.path.append('/home/joncrall/code/xdoctest/tests')
             >>> from test_plugin import *
             >>> testdir = explicit_testdir()
         """
@@ -306,7 +306,7 @@ def test_doctest_unexpected_exception(self, testdir):
 
         Ignore:
             >>> import sys
-            >>> sys.path.append('/home/joncrall/code/xdoctest/testing')
+            >>> sys.path.append('/home/joncrall/code/xdoctest/tests')
             >>> from test_plugin import *
             >>> testdir = explicit_testdir()
             >>> self = TestXDoctest()
@@ -597,7 +597,7 @@ def test_doctestmodule_external_and_issue116(self, testdir):
 
         Ignore:
             >>> import sys
-            >>> sys.path.append('/home/joncrall/code/xdoctest/testing')
+            >>> sys.path.append('/home/joncrall/code/xdoctest/tests')
             >>> from test_plugin import *
             >>> testdir = explicit_testdir()
             >>> self = TestXDoctest()
@@ -884,7 +884,7 @@ def test_stdout_capture_no(self, testdir):
 
         Ignore:
             >>> import sys
-            >>> sys.path.append('/home/joncrall/code/xdoctest/testing')
+            >>> sys.path.append('/home/joncrall/code/xdoctest/tests')
             >>> from test_plugin import *
             >>> testdir = explicit_testdir()
 
@@ -933,7 +933,7 @@ def test_doctestmodule(self, testdir):
 
         Ignore:
             >>> import sys
-            >>> sys.path.append('/home/joncrall/code/xdoctest/testing')
+            >>> sys.path.append('/home/joncrall/code/xdoctest/tests')
             >>> from test_plugin import *
             >>> testdir = explicit_testdir()
             >>> self = TestXDoctest()
@@ -958,7 +958,7 @@ def test_collect_module_single_modulelevel_doctest(self, testdir):
 
         Ignore:
             >>> import sys
-            >>> sys.path.append('/home/joncrall/code/xdoctest/testing')
+            >>> sys.path.append('/home/joncrall/code/xdoctest/tests')
             >>> from test_plugin import *
             >>> testdir = explicit_testdir()
             >>> self = TestXDoctestModuleLevel()
@@ -991,7 +991,7 @@ def test_collect_module_two_doctest_no_modulelevel(self, testdir):
 
         Ignore:
             >>> import sys
-            >>> sys.path.append('/home/joncrall/code/xdoctest/testing')
+            >>> sys.path.append('/home/joncrall/code/xdoctest/tests')
             >>> from test_plugin import *
             >>> testdir = explicit_testdir()
             >>> self = TestXDoctestModuleLevel()
diff --git a/tests/test_traceback.py b/tests/test_traceback.py
index c92665e4..49a3528e 100644
--- a/tests/test_traceback.py
+++ b/tests/test_traceback.py
@@ -114,6 +114,7 @@ def func(a):
     assert '>>> a = []()' in text
     assert 'rel: 6, abs: 9,' in text
 
+
 def test_failure_linenos():
     """
     Example:
@@ -255,11 +256,10 @@ def func(a):
     assert text
 
 
-
 if __name__ == '__main__':
     """
     CommandLine:
-        export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/testing
+        export PYTHONPATH=$PYTHONPATH:/home/joncrall/code/xdoctest/tests
         python ~/code/xdoctest/tests/test_traceback.py
         pytest ~/code/xdoctest/tests/test_traceback.py -s
     """
diff --git a/xdoctest/__init__.py b/xdoctest/__init__.py
index c6bae586..d83397ff 100644
--- a/xdoctest/__init__.py
+++ b/xdoctest/__init__.py
@@ -343,7 +343,10 @@ def _parse_changelog(fpath):
         >>> fpath = 'CHANGELOG.md'
         >>> _parse_changelog(fpath)
     """
-    from distutils.version import LooseVersion
+    try:
+        from packaging.version import parse as LooseVersion
+    except ImportError:
+        from distutils.version import LooseVersion
     import re
     pat = re.compile(r'#.*Version ([0-9]+\.[0-9]+\.[0-9]+)')
     # We can statically modify this to a constant value when we deploy
diff --git a/xdoctest/core.py b/xdoctest/core.py
index d9e04321..b476dbe9 100644
--- a/xdoctest/core.py
+++ b/xdoctest/core.py
@@ -530,7 +530,7 @@ def parse_calldefs(module_identifier, analysis='auto'):
     # backwards compatibility hacks
     if '--allow-xdoc-dynamic' in sys.argv:
         from xdoctest.utils import util_deprecation
-        util_deprecation.schedule_deprecation3(
+        util_deprecation.schedule_deprecation(
             modname='xdoctest',
             name='--allow-xdoc-dynamic', type='CLI flag',
             migration='use --analysis=auto instead',
@@ -539,7 +539,7 @@ def parse_calldefs(module_identifier, analysis='auto'):
         analysis = 'auto'
     if '--xdoc-force-dynamic' in sys.argv:
         from xdoctest.utils import util_deprecation
-        util_deprecation.schedule_deprecation3(
+        util_deprecation.schedule_deprecation(
             modname='xdoctest',
             name='--xdoc-force-dynamic', type='CLI flag',
             migration='use --analysis=dynamic instead',
diff --git a/xdoctest/directive.py b/xdoctest/directive.py
index 219669bc..bce6ff7e 100644
--- a/xdoctest/directive.py
+++ b/xdoctest/directive.py
@@ -438,7 +438,7 @@ def __nice__(self):
 
     def _unpack_args(self, num):
         from xdoctest.utils import util_deprecation
-        util_deprecation.schedule_deprecation3(
+        util_deprecation.schedule_deprecation(
             modname='xdoctest',
             name='Directive._unpack_args', type='method',
             migration='there is no need to use this',
@@ -453,7 +453,7 @@ def _unpack_args(self, num):
 
     def effect(self, argv=None, environ=None):
         from xdoctest.utils import util_deprecation
-        util_deprecation.schedule_deprecation3(
+        util_deprecation.schedule_deprecation(
             modname='xdoctest',
             name='Directive.effect', type='method',
             migration='Use Directive.effects instead',
diff --git a/xdoctest/static_analysis.py b/xdoctest/static_analysis.py
index 0a7b88f5..11193008 100644
--- a/xdoctest/static_analysis.py
+++ b/xdoctest/static_analysis.py
@@ -680,7 +680,7 @@ def parse_static_calldefs(source=None, fpath=None):
 
 def parse_calldefs(source=None, fpath=None):
     from xdoctest.utils import util_deprecation
-    util_deprecation.schedule_deprecation3(
+    util_deprecation.schedule_deprecation(
         modname='xdoctest',
         name='parse_calldefs', type='function',
         migration='use parse_static_calldefs instead',
diff --git a/xdoctest/utils/util_deprecation.py b/xdoctest/utils/util_deprecation.py
index 930fc417..65be0243 100644
--- a/xdoctest/utils/util_deprecation.py
+++ b/xdoctest/utils/util_deprecation.py
@@ -1,66 +1,123 @@
 """
 Utilities for helping robustly deprecate features.
 """
-import warnings
 
 
-DEP_SCHEDULE_1 = dict(deprecate='0.9.6', remove='1.0.0')
+def schedule_deprecation(modname, name='?', type='?', migration='',
+                         deprecate=None, error=None, remove=None):
+    """
+    Deprecation machinery to help provide users with a smoother transition.
 
+    This function provides a concise way to mark a feature as deprecated by
+    providing a description of the deprecated feature, documentation on how to
+    migrate away from the deprecated feature, and the versions that the feature
+    is scheduled for deprecation and eventual removal. Based on the version of
+    the library and the specified schedule this function will either do
+    nothing, emit a warning, or raise an error with helpful messages for both
+    users and developers.
 
-def paragraph(text):
-    r"""
-    Wraps multi-line strings and restructures the text to remove all newlines,
-    heading, trailing, and double spaces.
+    Args:
+        modname (str):
+            The name of the underlying module associated with the feature to be
+            deprecated. The module must already be imported and have a passable
+            ``__version__`` attribute.
 
-    Useful for writing log messages
+        name (str):
+            The name of the feature to deprecate. This is usually a function or
+            argument name.
 
-    Args:
-        text (str): typically a multiline string
+        type (str):
+            A description of what the feature is. This is not a formal type,
+            but rather a prose description: e.g. "argument to my_func".
 
-    Returns:
-        str: the reduced text block
+        migration (str):
+            A description that lets users know what they should do instead of
+            using the deprecated feature.
 
-    Example:
-        >>> text = (
-        >>>     '''
-        >>>     Lorem ipsum dolor sit amet, consectetur adipiscing
-        >>>     elit, sed do eiusmod tempor incididunt ut labore et
-        >>>     dolore magna aliqua.
-        >>>     ''')
-        >>> out = paragraph(text)
-        >>> assert chr(10) in text
-        >>> assert chr(10) not in out
-        >>> print('text = {!r}'.format(text))
-        >>> print('out = {!r}'.format(out))
-    """
-    import re
-    out = re.sub(r'\s\s*', ' ', text).strip()
-    return out
+        deprecate (str | None):
+            The version when the feature is officially deprecated and this
+            function should start to emit a deprecation warning.
 
+        error (str | None):
+            The version when the feature is officially no longer supported, and
+            will start to raise a RuntimeError.
 
-def schedule_deprecation3(modname, migration='', name='?', type='?', deprecate=None, error=None, remove=None):  # nocover
-    """
-    Deprecation machinery to help provide users with a smoother transition.
+        remove (str | None):
+            The version when the feature is completely removed. An
+            AssertionError will be raised if this function is still present
+            reminding the developer to remove the feature (or extend the remove
+            version).
+
+    Note:
+        The :class:`DeprecationWarning` is not visible by default.
+        https://docs.python.org/3/library/warnings.html
+
+    Example:
+        >>> import sys
+        >>> import types
+        >>> import pytest
+        >>> dummy_module = sys.modules['dummy_module'] = types.ModuleType('dummy_module')
+        >>> # When less than the deprecated version this does nothing
+        >>> dummy_module.__version__ = '1.0.0'
+        >>> schedule_deprecation(
+        ...     'dummy_module', 'myfunc', 'function', 'do something else',
+        ...     deprecate='1.1.0', error='1.2.0', remove='1.3.0')
+        >>> # Now this raises warning
+        >>> with pytest.warns(DeprecationWarning):
+        ...     dummy_module.__version__ = '1.1.0'
+        ...     schedule_deprecation(
+        ...         'dummy_module', 'myfunc', 'function', 'do something else',
+        ...         deprecate='1.1.0', error='1.2.0', remove='1.3.0')
+        >>> # Now this raises an error for the user
+        >>> with pytest.raises(RuntimeError):
+        ...     dummy_module.__version__ = '1.2.0'
+        ...     schedule_deprecation(
+        ...         'dummy_module', 'myfunc', 'function', 'do something else',
+        ...         deprecate='1.1.0', error='1.2.0', remove='1.3.0')
+        >>> # Now this raises an error for the developer
+        >>> with pytest.raises(AssertionError):
+        ...     dummy_module.__version__ = '1.3.0'
+        ...     schedule_deprecation(
+        ...         'dummy_module', 'myfunc', 'function', 'do something else',
+        ...         deprecate='1.1.0', error='1.2.0', remove='1.3.0')
+        >>> # When no versions are specified, it simply emits the warning
+        >>> with pytest.warns(DeprecationWarning):
+        ...     dummy_module.__version__ = '1.1.0'
+        ...     schedule_deprecation(
+        ...         'dummy_module', 'myfunc', 'function', 'do something else')
     """
     import sys
-    from distutils.version import LooseVersion
+    import warnings
+    try:
+        from packaging.version import parse as parse_version
+    except ImportError:
+        from distutils.version import LooseVersion as parse_version
     module = sys.modules[modname]
-    current = LooseVersion(module.__version__)
-    deprecate = None if deprecate is None else LooseVersion(deprecate)
-    remove = None if remove is None else LooseVersion(remove)
-    error = None if error is None else LooseVersion(error)
+    current = parse_version(module.__version__)
+    deprecate_str = ''
+    if deprecate is not None:
+        deprecate = parse_version(deprecate)
+        deprecate_str = ' in {}'.format(deprecate)
+    remove_str = ''
+    if remove is not None:
+        remove = parse_version(remove)
+        remove_str = ' in {}'.format(remove)
+    error_str = ''
+    if error is not None:
+        error = parse_version(error)
+        error_str = ' in {}'.format(error)
     if deprecate is None or current >= deprecate:
-        if migration is None:
-            migration = ''
-        msg = paragraph(
-            '''
-            The "{name}" {type} was deprecated in {deprecate}, will cause
-            an error in {error} and will be removed in {remove}. The current
-            version is {current}. {migration}
-            ''').format(**locals()).strip()
+        msg = (
+            'The "{name}" {type} was deprecated{deprecate_str}, will cause '
+            'an error{error_str} and will be removed{remove_str}. The current '
+            'version is {current}. {migration}'
+        ).format(**locals()).strip()
         if remove is not None and current >= remove:
-            raise AssertionError('forgot to remove a deprecated function')
+            raise AssertionError(
+                'Forgot to remove deprecated: ' + msg + ' ' +
+                'Remove the function, or extend the scheduled remove version.'
+            )
         if error is not None and current >= error:
-            raise DeprecationWarning(msg)
+            raise RuntimeError(msg)
         else:
             warnings.warn(msg, DeprecationWarning)
diff --git a/xdoctest/utils/util_stream.py b/xdoctest/utils/util_stream.py
index 8685a330..cf614056 100644
--- a/xdoctest/utils/util_stream.py
+++ b/xdoctest/utils/util_stream.py
@@ -141,7 +141,7 @@ def __init__(self, suppress=True, enabled=True, **kwargs):
         _misspelled_varname = 'supress'
         if _misspelled_varname in kwargs:  # nocover
             from xdoctest.utils import util_deprecation
-            util_deprecation.schedule_deprecation3(
+            util_deprecation.schedule_deprecation(
                 modname='xdoctest',
                 name='supress', type='Argument of CaptureStdout',
                 migration='Use suppress instead',

From dcccde361242f37fe92c7db663e0bc8d27d87f65 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 18:33:37 -0400
Subject: [PATCH 14/38] Fix loose version warnings

---
 tests/test_notebook.py | 5 ++++-
 tests/test_plugin.py   | 5 ++++-
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/tests/test_notebook.py b/tests/test_notebook.py
index 7fd213b7..808ef092 100644
--- a/tests/test_notebook.py
+++ b/tests/test_notebook.py
@@ -1,7 +1,10 @@
 import pytest
 import sys
 from os.path import join, exists, dirname
-from distutils.version import LooseVersion
+try:
+    from packaging.version import parse as LooseVersion
+except ImportError:
+    from distutils.version import LooseVersion
 
 PY_VERSION = LooseVersion('{}.{}'.format(*sys.version_info[0:2]))
 IS_MODERN_PYTHON = PY_VERSION > LooseVersion('3.4')
diff --git a/tests/test_plugin.py b/tests/test_plugin.py
index cd69486a..f7cd6d34 100644
--- a/tests/test_plugin.py
+++ b/tests/test_plugin.py
@@ -10,7 +10,10 @@
 from xdoctest.plugin import XDoctestItem, XDoctestModule, XDoctestTextfile
 from xdoctest import utils
 import pytest
-from distutils.version import LooseVersion
+try:
+    from packaging.version import parse as LooseVersion
+except ImportError:
+    from distutils.version import LooseVersion
 
 PY36 = sys.version_info[:2] >= (3, 6)
 MODULE_NOT_FOUND_ERROR = 'ModuleNotFoundError' if PY36 else 'ImportError'

From 22cf3cc3b1173241f5c1b6c79d916d3ccd7e2104 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 18:39:43 -0400
Subject: [PATCH 15/38] Removed convert google to numpy script

---
 CHANGELOG.md                               |   5 +-
 run_linter.sh                              |   0
 tests/test_parser.py                       |   1 -
 xdoctest/docstr/convert_google_to_numpy.py | 189 ---------------------
 4 files changed, 4 insertions(+), 191 deletions(-)
 mode change 100644 => 100755 run_linter.sh
 delete mode 100644 xdoctest/docstr/convert_google_to_numpy.py

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4c7573ef..a661485a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -17,7 +17,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 * Modified the google style return type parser to return a type if the 
   only content is some parsable python code.
 * Modified docscrape google to allow for parsing of `*args` and `**kwargs` in
-  args blocks. May move this to a standalone package soon.
+  args blocks. This has also moved to the standalone package `googledoc`
+* Overhaul of repo structure in an effort to modernize and to agree with
+  templates defined by xcookie
+
 
 
 ## Version 1.0.0 - Released 2022-03-25
diff --git a/run_linter.sh b/run_linter.sh
old mode 100644
new mode 100755
diff --git a/tests/test_parser.py b/tests/test_parser.py
index 5dcbe5d3..05b9faa1 100644
--- a/tests/test_parser.py
+++ b/tests/test_parser.py
@@ -166,7 +166,6 @@ def test_label_indented_lines():
     ]
     if labeled != expected:
         try:
-            # import ubelt as ub  # NOQA
             import itertools as it
             for got, want in it.zip_longest(labeled, expected):
                 if got != want:
diff --git a/xdoctest/docstr/convert_google_to_numpy.py b/xdoctest/docstr/convert_google_to_numpy.py
deleted file mode 100644
index 924913c1..00000000
--- a/xdoctest/docstr/convert_google_to_numpy.py
+++ /dev/null
@@ -1,189 +0,0 @@
-def argsort(indexable, key=None, reverse=False):
-    """
-    Returns the indices that would sort a indexable object.
-
-    This is similar to :func:`numpy.argsort`, but it is written in pure python
-    and works on both lists and dictionaries.
-
-    Args:
-        indexable (Iterable[B] | Mapping[A, B]): indexable to sort by
-
-        key (Callable[[A], B], default=None):
-            customizes the ordering of the indexable
-
-        reverse (bool, default=False): if True returns in descending order
-
-    Returns:
-        List[int]: indices - list of indices such that sorts the indexable
-
-    Example:
-        >>> # argsort works on dicts by returning keys
-        >>> dict_ = {'a': 3, 'b': 2, 'c': 100}
-        >>> indices = argsort(dict_)
-        >>> # argsort works on lists by returning indices
-        >>> indexable = [100, 2, 432, 10]
-        >>> indices = argsort(indexable)
-        >>> # Can use iterators, but be careful. It exhausts them.
-        >>> indexable = reversed(range(100))
-        >>> indices = argsort(indexable)
-        >>> assert indices[0] == 99
-        >>> # Can use key just like sorted
-        >>> indexable = [[0, 1, 2], [3, 4], [5]]
-        >>> indices = argsort(indexable, key=len)
-        >>> # Can use reverse just like sorted
-        >>> indexable = [0, 2, 1]
-        >>> indices = argsort(indexable, reverse=True)
-    """
-    try:
-        from collections import abc as collections_abc
-    except Exception:  # nocover
-        import collections as collections_abc
-    # Create an iterator of value/key pairs
-    if isinstance(indexable, collections_abc.Mapping):
-        vk_iter = ((v, k) for k, v in indexable.items())
-    else:
-        vk_iter = ((v, k) for k, v in enumerate(indexable))
-    # Sort by values and extract the indices
-    if key is None:
-        indices = [k for v, k in sorted(vk_iter, reverse=reverse)]
-    else:
-        # If key is provided, call it using the value as input
-        indices = [k for v, k in sorted(vk_iter, key=lambda vk: key(vk[0]),
-                                        reverse=reverse)]
-    return indices
-
-
-def convert_file_docstrings(path_to_convert, dry=True):
-    """
-    path_to_convert = ub.expandpath('~/code/networkx/networkx/algorithms/isomorphism/_embeddinghelpers/balanced_sequence.py')
-    """
-    from xdoctest.core import package_calldefs
-    pkg_calldefs = list(package_calldefs(path_to_convert))
-    def recnone(val, default):
-        return default if val is None else val
-
-    for calldefs, modpath in pkg_calldefs:
-        to_insert = []
-        with open(modpath, 'r') as file:
-            old_text = file.read()
-        old_lines = old_text.split('\n')
-        sortnames = argsort(calldefs, key=lambda node: recnone(node.doclineno, -1))
-        for name in sortnames:
-            node = calldefs[name]
-            if node.docstr is not None:
-                google_docstr = node.docstr
-                numpy_docstr = google_to_numpy_docstr(google_docstr)
-                body_lines = numpy_docstr.split('\n')
-                start = node.doclineno
-                stop = node.doclineno_end
-                to_insert.append((start, stop, body_lines))
-
-        to_insert = sorted(to_insert)[::-1]
-
-        new_lines = old_lines.copy()
-        for start, stop, body_lines in to_insert:
-            old_middle = old_lines[start - 1:stop]
-            print('old_middle = {}'.format(old_middle))
-            print('start = {!r}'.format(start))
-            startline = new_lines[start - 1]
-            print('startline = {!r}'.format(startline))
-            ssline = startline.strip(' ')
-            sq = ssline[0]
-            tq = sq * 3
-            n_indent = len(startline) - len(ssline)
-            indent = ' ' * n_indent
-            print('n_indent = {!r}'.format(n_indent))
-            body_lines = [indent + line for line in body_lines]
-            body_lines = [indent + tq] + body_lines + [indent + tq]
-            prefix = new_lines[: start - 1]
-            suffix = new_lines[stop:]
-            mid = body_lines
-            new_lines = prefix + mid + suffix
-
-        new_text = '\n'.join(new_lines)
-        # print(new_text)
-        if dry:
-            import xdev
-            print(xdev.misc.difftext(old_text, new_text, context_lines=10, colored=True))
-            print('^^^ modpath = {!r}'.format(modpath))
-        else:
-            with open(modpath, 'w') as file:
-                file.write(new_text)
-
-
-def google_to_numpy_docstr(docstr):
-    """
-    Convert a google-style docstring to a numpy-style docstring
-
-    Args:
-        docstr (str): contents of ``func.__doc__`` for some ``func``, assumed
-            to be in google-style.
-
-    Returns:
-        str: numpy style docstring
-    """
-    from xdoctest.utils.util_str import indent as indent_fn
-    from xdoctest.docstr import docscrape_google
-    docblocks = docscrape_google.split_google_docblocks(docstr)
-    new_parts = []
-    for key, block in docblocks:
-        old_body, relpos = block
-        new_key = key
-        new_body = old_body
-
-        if key == '__DOC__':
-            new_key = None
-            new_text = new_body
-        elif key in {'Args'}:
-            new_key = 'Parameters'
-            arginfos = list(
-                docscrape_google.parse_google_argblock(old_body))
-            parts = []
-            for info in arginfos:
-                info['desc'] = indent_fn(info['desc'])
-                p = '{name}: {type}\n{desc}'.format(**info)
-                parts.append(p)
-                parts.append('')
-            new_body = '\n'.join(parts)
-        if key in {'Returns', 'Yields'}:
-            retinfos = list(
-                docscrape_google.parse_google_retblock(old_body))
-            parts = []
-            for info in retinfos:
-                info['desc'] = indent_fn(info['desc'])
-                info['name'] = info.get('name', '')
-                parts.append('{name}: {type}\n{desc}'.format(**info))
-                parts.append('')
-            new_body = '\n'.join(parts)
-
-        if new_key is not None:
-            new_text = '\n'.join(
-                [new_key, '-' * len(new_key), new_body])
-
-        if new_text.strip():
-            new_parts.append(new_text)
-
-    new_docstr = '\n'.join(new_parts)
-    new_docstr = new_docstr.strip('\n')
-    return new_docstr
-
-
-def main():
-    import scriptconfig as scfg
-    class Config(scfg.Config):
-        default = {
-            'src': scfg.Value(None, help='path to file to convert'),
-            'dry': scfg.Value(True, help='set to false to execute'),
-        }
-    config = Config(cmdline=True)
-    path_to_convert = config['src']
-    dry = config['dry']
-    convert_file_docstrings(path_to_convert, dry=dry)
-
-
-if __name__ == '__main__':
-    """
-    CommandLine:
-        python -m xdoctest.docstr.convert_google_to_numpy --src ~/code/networkx/networkx/algorithms/isomorphism/_embeddinghelpers/balanced_sequence.py
-    """
-    main()

From a4958c008e7a98d441f030d266d58f5f309cc4e4 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 18:41:42 -0400
Subject: [PATCH 16/38] remove 3.4

---
 .github/workflows/tests.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 9c33b588..8b91d9b6 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -100,7 +100,7 @@ jobs:
         - macOS-latest
         python-version:
         - '2.7'
-        - '3.4'
+        #- '3.4'
         - '3.5'
         - '3.6'
         - '3.7'

From 3b7bd6d114d09ecf9276bf138d8bbd6928c7d71a Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 18:43:48 -0400
Subject: [PATCH 17/38] Fix some types

---
 xdoctest/constants.py  | 2 +-
 xdoctest/exceptions.py | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/xdoctest/constants.py b/xdoctest/constants.py
index 27be088b..c5e19d2e 100644
--- a/xdoctest/constants.py
+++ b/xdoctest/constants.py
@@ -30,6 +30,6 @@ def __bool__(self):
         return False
     __nonzero__ = __bool__
 try:
-    NOT_EVALED  # pragma: no cover
+    NOT_EVALED  # type: ignore
 except NameError:  # pragma: no cover
     NOT_EVALED = object.__new__(_NOT_EVAL_TYPE)  # pragma: no cover
diff --git a/xdoctest/exceptions.py b/xdoctest/exceptions.py
index 9a4b0deb..1c05f763 100644
--- a/xdoctest/exceptions.py
+++ b/xdoctest/exceptions.py
@@ -38,7 +38,7 @@ class IncompleteParseError(SyntaxError):
     import _pytest.outcomes
 except ImportError:  # nocover
     # Define dummy skipped exception if pytest is not available
-    class _pytest(object):
+    class _pytest(object):  # type: ignore
         class outcomes(object):
             class Skipped(Exception):
                 pass

From be9ad5aacdd6d2455e06c213b3102c3fc6233c7d Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 18:50:43 -0400
Subject: [PATCH 18/38] Attempt 2.7 fix

---
 xdoctest/plugin.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/xdoctest/plugin.py b/xdoctest/plugin.py
index ce2339a0..006d5f11 100644
--- a/xdoctest/plugin.py
+++ b/xdoctest/plugin.py
@@ -116,8 +116,8 @@ def str_lower(x):
 
 
 if pytest.__version__ < '7.':
-    def pytest_collect_file(file_path, parent):
-        return _pytest_collect_file(file_path, parent, fspath=file_path)
+    def pytest_collect_file(path, parent):
+        return _pytest_collect_file(path, parent, fspath=path)
 
     def _suffix(path):
         return path.ext
@@ -126,7 +126,7 @@ def _match(path, glob):
         return path.check(fnmatch=glob)
 
 else:
-    def pytest_collect_file(file_path, parent):
+    def pytest_collect_file(file_path, parent):  # type: ignore
         return _pytest_collect_file(file_path, parent, path=file_path)
 
     def _suffix(path):

From f29994cbf02fced2565a0933f9e7db6556068358 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 19:02:59 -0400
Subject: [PATCH 19/38] Bump min jupyter core

---
 requirements/jupyter.txt | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/requirements/jupyter.txt b/requirements/jupyter.txt
index d7800ef2..3041d6d3 100644
--- a/requirements/jupyter.txt
+++ b/requirements/jupyter.txt
@@ -1,4 +1,7 @@
 # See ~/local/tools/supported_python_versions_pip.py for helper script
+# python ~/local/tools/supported_python_versions_pip.py jupyter_client
+# python ~/local/tools/supported_python_versions_pip.py nbconvert
+# python ~/local/tools/supported_python_versions_pip.py jupyter_core
 
 
 nbconvert>=6.0.0;                              python_version >= '3.6.0'   # Python 3.6+
@@ -30,7 +33,7 @@ attrs>=19.2.0   ; python_version >= '3.6'    # Python 3.6+
 
 
 # For jupyter-client
-jupyter_core >= 4.6.0  ; python_version >= '3.6'    # Python 3.6+
+jupyter_core >= 4.7.0  ; python_version >= '3.6'    # Python 3.6+
 
 
 # For jupyter-core

From 726fcb3ff71363eb51ac29c7ea41f9d1ed83b92b Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 19:07:42 -0400
Subject: [PATCH 20/38] fixing min versions

---
 requirements/jupyter.txt | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/requirements/jupyter.txt b/requirements/jupyter.txt
index 3041d6d3..f15abe24 100644
--- a/requirements/jupyter.txt
+++ b/requirements/jupyter.txt
@@ -2,6 +2,10 @@
 # python ~/local/tools/supported_python_versions_pip.py jupyter_client
 # python ~/local/tools/supported_python_versions_pip.py nbconvert
 # python ~/local/tools/supported_python_versions_pip.py jupyter_core
+# python ~/local/tools/supported_python_versions_pip.py IPython
+# python ~/local/tools/supported_python_versions_pip.py debugpy
+# python ~/local/tools/supported_python_versions_pip.py jedi
+# python ~/local/tools/supported_python_versions_pip.py attrs
 
 
 nbconvert>=6.0.0;                              python_version >= '3.6.0'   # Python 3.6+
@@ -20,7 +24,11 @@ ipykernel>=5.2.0     ; python_version < '3.7' and python_version >= '3.6'    # P
 
 
 # For IPython-kernel
-debugpy>=1.0.0 ; python_version >= '3.6'    # Python 3.6+
+debugpy>=1.6.0     ;                            python_version >= '3.10'    # Python 3.10+
+debugpy>=1.3.0     ; python_version < '3.10' and python_version >= '3.9'    # Python 3.9
+debugpy>=1.0.0     ; python_version < '3.9' and python_version >= '3.8'    # Python 3.8
+debugpy>=1.0.0     ; python_version < '3.8' and python_version >= '3.7'    # Python 3.7
+debugpy>=1.0.0     ; python_version < '3.7' and python_version >= '3.6'    # Python 3.6
 
 
 # For IPython

From 5d59f48a7a0f9add5bb8726e1b77f005c2f4fc52 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 19:23:31 -0400
Subject: [PATCH 21/38] Add types and fix google docstrings to agree

---
 MANIFEST.in                          |   1 +
 requirements/jupyter.txt             |   6 ++
 setup.py                             |   3 +
 xdoctest/__main__.pyi                |   5 ++
 xdoctest/checker.pyi                 |  57 ++++++++++++++
 xdoctest/constants.pyi               |  27 +++++++
 xdoctest/core.py                     |  12 +--
 xdoctest/core.pyi                    |  75 +++++++++++++++++++
 xdoctest/demo.pyi                    |  20 +++++
 xdoctest/directive.pyi               |  86 +++++++++++++++++++++
 xdoctest/docstr/docscrape_google.py  |   4 +-
 xdoctest/docstr/docscrape_google.pyi |  41 ++++++++++
 xdoctest/docstr/docscrape_numpy.pyi  |   1 +
 xdoctest/doctest_example.pyi         | 107 +++++++++++++++++++++++++++
 xdoctest/doctest_part.pyi            |  72 ++++++++++++++++++
 xdoctest/dynamic_analysis.py         |  17 +++--
 xdoctest/dynamic_analysis.pyi        |  33 +++++++++
 xdoctest/exceptions.pyi              |  35 +++++++++
 xdoctest/global_state.pyi            |   7 ++
 xdoctest/parser.pyi                  |  15 ++++
 xdoctest/plugin.pyi                  |  71 ++++++++++++++++++
 xdoctest/py.typed                    |   0
 xdoctest/runner.pyi                  |  25 +++++++
 xdoctest/static_analysis.pyi         | 106 ++++++++++++++++++++++++++
 xdoctest/utils/util_deprecation.pyi  |  11 +++
 xdoctest/utils/util_import.py        |   4 +-
 xdoctest/utils/util_import.pyi       |  56 ++++++++++++++
 xdoctest/utils/util_misc.pyi         |  23 ++++++
 xdoctest/utils/util_mixins.pyi       |   2 +
 xdoctest/utils/util_notebook.py      |   8 +-
 xdoctest/utils/util_notebook.pyi     |  36 +++++++++
 xdoctest/utils/util_path.pyi         |  28 +++++++
 xdoctest/utils/util_str.pyi          |  33 +++++++++
 xdoctest/utils/util_stream.py        |   4 +-
 xdoctest/utils/util_stream.pyi       |  67 +++++++++++++++++
 35 files changed, 1076 insertions(+), 22 deletions(-)
 create mode 100644 xdoctest/__main__.pyi
 create mode 100644 xdoctest/checker.pyi
 create mode 100644 xdoctest/constants.pyi
 create mode 100644 xdoctest/core.pyi
 create mode 100644 xdoctest/demo.pyi
 create mode 100644 xdoctest/directive.pyi
 create mode 100644 xdoctest/docstr/docscrape_google.pyi
 create mode 100644 xdoctest/docstr/docscrape_numpy.pyi
 create mode 100644 xdoctest/doctest_example.pyi
 create mode 100644 xdoctest/doctest_part.pyi
 create mode 100644 xdoctest/dynamic_analysis.pyi
 create mode 100644 xdoctest/exceptions.pyi
 create mode 100644 xdoctest/global_state.pyi
 create mode 100644 xdoctest/parser.pyi
 create mode 100644 xdoctest/plugin.pyi
 create mode 100644 xdoctest/py.typed
 create mode 100644 xdoctest/runner.pyi
 create mode 100644 xdoctest/static_analysis.pyi
 create mode 100644 xdoctest/utils/util_deprecation.pyi
 create mode 100644 xdoctest/utils/util_import.pyi
 create mode 100644 xdoctest/utils/util_misc.pyi
 create mode 100644 xdoctest/utils/util_mixins.pyi
 create mode 100644 xdoctest/utils/util_notebook.pyi
 create mode 100644 xdoctest/utils/util_path.pyi
 create mode 100644 xdoctest/utils/util_str.pyi
 create mode 100644 xdoctest/utils/util_stream.pyi

diff --git a/MANIFEST.in b/MANIFEST.in
index 99d9d60f..86030011 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,5 +1,6 @@
 include *.md
 include *.py
+include *.toml
 include run_doctests.sh
 include *.txt
 include LICENSE
diff --git a/requirements/jupyter.txt b/requirements/jupyter.txt
index f15abe24..d4313378 100644
--- a/requirements/jupyter.txt
+++ b/requirements/jupyter.txt
@@ -6,6 +6,7 @@
 # python ~/local/tools/supported_python_versions_pip.py debugpy
 # python ~/local/tools/supported_python_versions_pip.py jedi
 # python ~/local/tools/supported_python_versions_pip.py attrs
+# python ~/local/tools/supported_python_versions_pip.py ipython_genutils
 
 
 nbconvert>=6.0.0;                              python_version >= '3.6.0'   # Python 3.6+
@@ -31,6 +32,11 @@ debugpy>=1.0.0     ; python_version < '3.8' and python_version >= '3.7'    # Pyt
 debugpy>=1.0.0     ; python_version < '3.7' and python_version >= '3.6'    # Python 3.6
 
 
+# Needed for 3.10 tests
+ipython_genutils >= 0.2.0 ;                            python_version >= '3.10'    # Python 3.10+
+
+
+
 # For IPython
 jedi>=0.16  ; python_version >= '3.6'    # Python 3.6+
 
diff --git a/setup.py b/setup.py
index 101a1b42..a91ccb02 100755
--- a/setup.py
+++ b/setup.py
@@ -222,6 +222,9 @@ def gen_packages_items():
         # packages=['xdoctest', 'xdoctest.utils', 'xdoctest.docstr'],
         # custom PyPI classifier for pytest plugins
         python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*',
+        package_data={
+            'xdoctest': ['py.typed', '*.pyi'],
+        },
         classifiers=[
             'Development Status :: 5 - Production/Stable',
             'Intended Audience :: Developers',
diff --git a/xdoctest/__main__.pyi b/xdoctest/__main__.pyi
new file mode 100644
index 00000000..cbad04cb
--- /dev/null
+++ b/xdoctest/__main__.pyi
@@ -0,0 +1,5 @@
+from _typeshed import Incomplete
+
+
+def main(argv: Incomplete | None = ...):
+    ...
diff --git a/xdoctest/checker.pyi b/xdoctest/checker.pyi
new file mode 100644
index 00000000..9b2e5311
--- /dev/null
+++ b/xdoctest/checker.pyi
@@ -0,0 +1,57 @@
+from _typeshed import Incomplete
+
+unicode_literal_re: Incomplete
+bytes_literal_re: Incomplete
+BLANKLINE_MARKER: str
+ELLIPSIS_MARKER: str
+TRAILING_WS: Incomplete
+
+
+def check_got_vs_want(want: str,
+                      got_stdout: str,
+                      got_eval: str = ...,
+                      runstate: Incomplete | None = ...):
+    ...
+
+
+def extract_exc_want(want):
+    ...
+
+
+def check_exception(exc_got, want, runstate: Incomplete | None = ...):
+    ...
+
+
+def check_output(got, want, runstate: Incomplete | None = ...):
+    ...
+
+
+def normalize(got, want, runstate: Incomplete | None = ...):
+    ...
+
+
+class ExtractGotReprException(AssertionError):
+    orig_ex: Incomplete
+
+    def __init__(self, msg, orig_ex) -> None:
+        ...
+
+
+class GotWantException(AssertionError):
+    got: Incomplete
+    want: Incomplete
+
+    def __init__(self, msg, got, want) -> None:
+        ...
+
+    def output_difference(self,
+                          runstate: Incomplete | None = ...,
+                          colored: bool = ...):
+        ...
+
+    def output_repr_difference(self, runstate: Incomplete | None = ...):
+        ...
+
+
+def remove_blankline_marker(text):
+    ...
diff --git a/xdoctest/constants.pyi b/xdoctest/constants.pyi
new file mode 100644
index 00000000..561290a0
--- /dev/null
+++ b/xdoctest/constants.pyi
@@ -0,0 +1,27 @@
+from _typeshed import Incomplete
+
+
+class _NOT_EVAL_TYPE:
+
+    def __new__(cls):
+        ...
+
+    def __reduce__(self):
+        ...
+
+    def __copy__(self):
+        ...
+
+    def __deepcopy__(self, memo):
+        ...
+
+    def __call__(self, default) -> None:
+        ...
+
+    def __bool__(self):
+        ...
+
+    __nonzero__: Incomplete
+
+
+NOT_EVALED: Incomplete
diff --git a/xdoctest/core.py b/xdoctest/core.py
index b476dbe9..113f8637 100644
--- a/xdoctest/core.py
+++ b/xdoctest/core.py
@@ -444,7 +444,7 @@ def package_calldefs(pkg_identifier, exclude=[], ignore_syntax_errors=True,
     Statically generates all callable definitions in a module or package
 
     Args:
-        pkg_identifier (str | Module): path to or name of the module to be
+        pkg_identifier (str | ModuleType): path to or name of the module to be
             tested (or the live module itself, which is not recommended)
 
         exclude (List[str]): glob-patterns of file names to exclude
@@ -459,7 +459,7 @@ def package_calldefs(pkg_identifier, exclude=[], ignore_syntax_errors=True,
             dynamic analysis is used to parse all calldefs.
 
     Yields:
-        Tuple[Dict[str, CallDefNode], str | Module] -
+        Tuple[Dict[str, xdoctest.static_analysis.CallDefNode], str | ModuleType] -
             * item[0]: the mapping of callnames-to-calldefs
             * item[1]: the path to the file containing the doctest
               (usually a module) or the module itself
@@ -514,7 +514,7 @@ def parse_calldefs(module_identifier, analysis='auto'):
     analysis.
 
     Args:
-        module_identifier (str | Module): path to or name of the module to be
+        module_identifier (str | ModuleType): path to or name of the module to be
             tested (or the live module itself, which is not recommended)
 
         analysis (str, default='auto'):
@@ -524,8 +524,8 @@ def parse_calldefs(module_identifier, analysis='auto'):
             dynamic analysis is used to parse all calldefs.
 
     Returns:
-        Dict[str, CallDefNode]: the mapping of callnames-to-calldefs within
-          the module.
+        Dict[str, xdoctest.static_analysis.CallDefNode]:
+            the mapping of callnames-to-calldefs within the module.
     """
     # backwards compatibility hacks
     if '--allow-xdoc-dynamic' in sys.argv:
@@ -607,7 +607,7 @@ def parse_doctestables(module_identifier, exclude=[], style='auto',
     example objects.  The style influences which tests are found.
 
     Args:
-        module_identifier (str | PathLike | Module):
+        module_identifier (str | PathLike | ModuleType):
             path or name of a module or a module itself (we prefer a path)
 
         exclude (List[str]): glob-patterns of file names to exclude
diff --git a/xdoctest/core.pyi b/xdoctest/core.pyi
new file mode 100644
index 00000000..87c45780
--- /dev/null
+++ b/xdoctest/core.pyi
@@ -0,0 +1,75 @@
+from typing import Union
+from os import PathLike
+import xdoctest
+from types import ModuleType
+from typing import List
+from typing import Dict
+from _typeshed import Incomplete
+from collections.abc import Generator
+from typing import Any
+
+DOCTEST_STYLES: Incomplete
+
+
+def parse_freeform_docstr_examples(
+    docstr: str,
+    callname: str = None,
+    modpath: Union[str, PathLike] = None,
+    lineno: int = 1,
+    fpath: Union[str, PathLike] = None,
+    asone: bool = True
+) -> Generator[xdoctest.doctest_example.DocTest, None, Any]:
+    ...
+
+
+def parse_google_docstr_examples(
+    docstr: str,
+    callname: str = None,
+    modpath: Union[str, PathLike] = None,
+    lineno: int = 1,
+    fpath: Union[str, PathLike] = None,
+    eager_parse: bool = True
+) -> Generator[xdoctest.doctest_example.DocTest, None, None]:
+    ...
+
+
+def parse_auto_docstr_examples(docstr, *args,
+                               **kwargs) -> Generator[Any, None, None]:
+    ...
+
+
+def parse_docstr_examples(
+    docstr: str,
+    callname: str = None,
+    modpath: Union[str, PathLike] = None,
+    lineno: int = 1,
+    style: str = 'auto',
+    fpath: Union[str, PathLike] = None,
+    parser_kw: dict = ...
+) -> Generator[xdoctest.doctest_example.DocTest, None, None]:
+    ...
+
+
+def package_calldefs(pkg_identifier: Union[str, ModuleType],
+                     exclude: List[str] = ...,
+                     ignore_syntax_errors: bool = True,
+                     analysis: str = 'auto') -> Generator[None, None, None]:
+    ...
+
+
+def parse_calldefs(
+        module_identifier: Union[str, ModuleType],
+        analysis: str = 'auto'
+) -> Dict[str, xdoctest.static_analysis.CallDefNode]:
+    ...
+
+
+def parse_doctestables(
+    module_identifier: Union[str, PathLike, ModuleType],
+    exclude: List[str] = ...,
+    style: str = 'auto',
+    ignore_syntax_errors: bool = True,
+    parser_kw=...,
+    analysis: str = 'auto'
+) -> Generator[xdoctest.doctest_example.DocTest, None, None]:
+    ...
diff --git a/xdoctest/demo.pyi b/xdoctest/demo.pyi
new file mode 100644
index 00000000..2846a559
--- /dev/null
+++ b/xdoctest/demo.pyi
@@ -0,0 +1,20 @@
+from _typeshed import Incomplete
+
+
+def myfunc():
+    ...
+
+
+class MyClass:
+    data: Incomplete
+
+    def __init__(self, *args, **kw) -> None:
+        ...
+
+    @classmethod
+    def demo(cls, **kw):
+        ...
+
+    @staticmethod
+    def always_fails() -> None:
+        ...
diff --git a/xdoctest/directive.pyi b/xdoctest/directive.pyi
new file mode 100644
index 00000000..3689a866
--- /dev/null
+++ b/xdoctest/directive.pyi
@@ -0,0 +1,86 @@
+from typing import List
+from typing import Dict
+from _typeshed import Incomplete
+from collections.abc import Generator
+from typing import NamedTuple
+from xdoctest import utils
+
+
+def named(key, pattern):
+    ...
+
+
+DEFAULT_RUNTIME_STATE: Incomplete
+
+
+class Effect(NamedTuple):
+    action: Incomplete
+    key: Incomplete
+    value: Incomplete
+
+
+class RuntimeState(utils.NiceRepr):
+
+    def __init__(self, default_state: Incomplete | None = ...) -> None:
+        ...
+
+    def to_dict(self):
+        ...
+
+    def __nice__(self):
+        ...
+
+    def __getitem__(self, key):
+        ...
+
+    def __setitem__(self, key, value) -> None:
+        ...
+
+    def set_report_style(self,
+                         reportchoice,
+                         state: Incomplete | None = ...) -> None:
+        ...
+
+    def update(self, directives: List[Directive]) -> None:
+        ...
+
+
+class Directive(utils.NiceRepr):
+    name: Incomplete
+    args: Incomplete
+    inline: Incomplete
+    positive: Incomplete
+
+    def __init__(self,
+                 name,
+                 positive: bool = ...,
+                 args=...,
+                 inline: Incomplete | None = ...) -> None:
+        ...
+
+    @classmethod
+    def extract(cls, text: str) -> Generator[Directive, None, None]:
+        ...
+
+    def __nice__(self):
+        ...
+
+    def effect(self,
+               argv: Incomplete | None = ...,
+               environ: Incomplete | None = ...):
+        ...
+
+    def effects(self,
+                argv: List[str] = None,
+                environ: Dict[str, str] = None) -> List[Effect]:
+        ...
+
+
+COMMANDS: Incomplete
+DIRECTIVE_PATTERNS: Incomplete
+DIRECTIVE_RE: Incomplete
+
+
+def parse_directive_optstr(optpart,
+                           inline: Incomplete | None = ...) -> Directive:
+    ...
diff --git a/xdoctest/docstr/docscrape_google.py b/xdoctest/docstr/docscrape_google.py
index feea1637..c2403dc2 100644
--- a/xdoctest/docstr/docscrape_google.py
+++ b/xdoctest/docstr/docscrape_google.py
@@ -33,7 +33,7 @@ def split_google_docblocks(docstr):
         docstr (str): a docstring
 
     Returns:
-        List[Tuple[str, DocBlock[str, int]]]:
+        List[Tuple[str, DocBlock]]:
             list of 2-tuples where the first item is a google style docstring
             tag and the second item is the bock corresponding to that tag. The
             block itself is a 2-tuple where the first item is the unindented
@@ -303,7 +303,7 @@ def parse_google_returns(docstr, return_annot=None):
         >>> docstr = split_google_docblocks.__doc__
         >>> retdict_list = list(parse_google_returns(docstr))
         >>> print([sorted(d.items())[1] for d in retdict_list])
-        [('type', 'List[Tuple[str, DocBlock[str, int]]]')]
+        [('type', 'List[Tuple[str, DocBlock]]')]
     """
     blocks = split_google_docblocks(docstr)
     for key, block in blocks:
diff --git a/xdoctest/docstr/docscrape_google.pyi b/xdoctest/docstr/docscrape_google.pyi
new file mode 100644
index 00000000..2ba2b9c3
--- /dev/null
+++ b/xdoctest/docstr/docscrape_google.pyi
@@ -0,0 +1,41 @@
+from typing import List
+from typing import Tuple
+from typing import Dict
+from typing import Union
+from _typeshed import Incomplete
+from collections.abc import Generator
+from typing import Any, NamedTuple
+
+
+class DocBlock(NamedTuple):
+    text: Incomplete
+    offset: Incomplete
+
+
+def split_google_docblocks(docstr: str) -> List[Tuple[str, DocBlock]]:
+    ...
+
+
+def parse_google_args(docstr: str) -> Generator[Dict[str, str], None, None]:
+    ...
+
+
+def parse_google_returns(
+    docstr: str,
+    return_annot: Union[str, None] = None
+) -> Generator[Dict[str, str], None, None]:
+    ...
+
+
+def parse_google_retblock(
+    lines: str,
+    return_annot: Union[str,
+                        None] = None) -> Generator[Dict[str, str], None, Any]:
+    ...
+
+
+def parse_google_argblock(
+        lines: str,
+        clean_desc: bool = True
+) -> Generator[Dict[str, str | None], None, Any]:
+    ...
diff --git a/xdoctest/docstr/docscrape_numpy.pyi b/xdoctest/docstr/docscrape_numpy.pyi
new file mode 100644
index 00000000..8b137891
--- /dev/null
+++ b/xdoctest/docstr/docscrape_numpy.pyi
@@ -0,0 +1 @@
+
diff --git a/xdoctest/doctest_example.pyi b/xdoctest/doctest_example.pyi
new file mode 100644
index 00000000..732a19f0
--- /dev/null
+++ b/xdoctest/doctest_example.pyi
@@ -0,0 +1,107 @@
+from typing import Dict
+from _typeshed import Incomplete
+from collections.abc import Generator
+from typing import Any
+
+__devnotes__: str
+
+
+class DoctestConfig(dict):
+
+    def __init__(self, *args, **kwargs) -> None:
+        ...
+
+    def getvalue(self, key, given: Incomplete | None = ...):
+        ...
+
+
+class DocTest:
+    UNKNOWN_MODNAME: str
+    UNKNOWN_MODPATH: str
+    UNKNOWN_CALLNAME: str
+    UNKNOWN_FPATH: str
+    block_type: Incomplete
+    config: Incomplete
+    module: Incomplete
+    modpath: Incomplete
+    fpath: Incomplete
+    modname: Incomplete
+    callname: Incomplete
+    docsrc: Incomplete
+    lineno: Incomplete
+    num: Incomplete
+    failed_tb_lineno: Incomplete
+    exc_info: Incomplete
+    failed_part: Incomplete
+    warn_list: Incomplete
+    logged_evals: Incomplete
+    logged_stdout: Incomplete
+    global_namespace: Incomplete
+    mode: Incomplete
+
+    def __init__(self,
+                 docsrc,
+                 modpath: Incomplete | None = ...,
+                 callname: Incomplete | None = ...,
+                 num: int = ...,
+                 lineno: int = ...,
+                 fpath: Incomplete | None = ...,
+                 block_type: Incomplete | None = ...,
+                 mode: str = ...) -> None:
+        ...
+
+    def __nice__(self):
+        ...
+
+    def is_disabled(self, pytest: bool = ...):
+        ...
+
+    @property
+    def unique_callname(self):
+        ...
+
+    @property
+    def node(self):
+        ...
+
+    @property
+    def valid_testnames(self):
+        ...
+
+    def wants(self) -> Generator[Any, None, None]:
+        ...
+
+    def format_parts(self,
+                     linenos: bool = ...,
+                     colored: Incomplete | None = ...,
+                     want: bool = ...,
+                     offset_linenos: Incomplete | None = ...,
+                     prefix: bool = ...) -> Generator[Any, None, None]:
+        ...
+
+    def format_src(self,
+                   linenos: bool = True,
+                   colored: bool = None,
+                   want: bool = True,
+                   offset_linenos: bool = None,
+                   prefix: bool = True):
+        ...
+
+    def anything_ran(self):
+        ...
+
+    def run(self, verbose: int = None, on_error: str = None) -> Dict:
+        ...
+
+    @property
+    def cmdline(self) -> str:
+        ...
+
+    def failed_line_offset(self):
+        ...
+
+    def failed_lineno(self):
+        ...
+
+    def repr_failure(self, with_tb: bool = ...):
+        ...
diff --git a/xdoctest/doctest_part.pyi b/xdoctest/doctest_part.pyi
new file mode 100644
index 00000000..e8ab8897
--- /dev/null
+++ b/xdoctest/doctest_part.pyi
@@ -0,0 +1,72 @@
+from _typeshed import Incomplete
+from xdoctest import directive
+
+__devnotes__: str
+
+
+class DoctestPart:
+    exec_lines: Incomplete
+    want_lines: Incomplete
+    line_offset: Incomplete
+    orig_lines: Incomplete
+    compile_mode: str
+    partno: Incomplete
+
+    def __init__(self,
+                 exec_lines,
+                 want_lines: Incomplete | None = ...,
+                 line_offset: int = ...,
+                 orig_lines: Incomplete | None = ...,
+                 directives: Incomplete | None = ...,
+                 partno: Incomplete | None = ...) -> None:
+        ...
+
+    @property
+    def n_lines(self):
+        ...
+
+    @property
+    def n_exec_lines(self):
+        ...
+
+    @property
+    def n_want_lines(self):
+        ...
+
+    @property
+    def source(self):
+        ...
+
+    def compilable_source(self):
+        ...
+
+    def has_any_code(self):
+        ...
+
+    @property
+    def directives(self):
+        ...
+
+    @property
+    def want(self):
+        ...
+
+    def __nice__(self):
+        ...
+
+    def check(part,
+              got_stdout: str,
+              got_eval: str = ...,
+              runstate: directive.RuntimeState = None,
+              unmatched: list = None) -> None:
+        ...
+
+    def format_part(self,
+                    linenos: bool = True,
+                    want: bool = True,
+                    startline: int = 1,
+                    n_digits: int = None,
+                    colored: bool = False,
+                    partnos: bool = False,
+                    prefix: bool = True):
+        ...
diff --git a/xdoctest/dynamic_analysis.py b/xdoctest/dynamic_analysis.py
index 96b40383..b738e105 100644
--- a/xdoctest/dynamic_analysis.py
+++ b/xdoctest/dynamic_analysis.py
@@ -18,10 +18,11 @@ def parse_dynamic_calldefs(modpath_or_module):
     this can discover doctests in binary extension libraries.
 
     Args:
-       modpath_or_module (str | Module): path to module or the module itself
+       modpath_or_module (str | PathLike | ModuleType):
+           path to module or the module itself
 
     Returns:
-        Dict[str, CallDefNode]:
+        Dict[str, xdoctest.static_analysis.CallDefNode]:
             mapping from callnames to CallDefNodes, which contain
                info about the item with the doctest.
 
@@ -95,7 +96,7 @@ def get_stack_frame(n=0, strict=True):
         strict (bool): (default = True)
 
     Returns:
-        frame: frame_cur
+        FrameType: frame_cur
 
     Example:
         >>> frame_cur = get_stack_frame(n=0)
@@ -125,7 +126,7 @@ def get_parent_frame(n=0):
                  n=1 is the parent frame.
 
     Returns:
-        frame: parent_frame
+        FrameType: parent_frame
 
     Example:
         >>> root0 = get_stack_frame(n=0)
@@ -154,10 +155,10 @@ def iter_module_doctestables(module):
     Yields doctestable objects that belong to a live python module
 
     Args:
-        module (module): live python module
+        module (ModuleType): live python module
 
     Yields:
-        tuple (str, callable): (funcname, func) doctestable
+        Tuple[str, callable]: (funcname, func) doctestable
 
     CommandLine:
         python -m xdoctest.dynamic_analysis iter_module_doctestables
@@ -228,6 +229,10 @@ def is_defined_by_module(item, module):
 
     This check may not always work, especially for decorated functions.
 
+    Args:
+        item (object): item to check
+        module (ModuleType): module to check against
+
     CommandLine:
         xdoctest -m xdoctest.dynamic_analysis is_defined_by_module
 
diff --git a/xdoctest/dynamic_analysis.pyi b/xdoctest/dynamic_analysis.pyi
new file mode 100644
index 00000000..5b01c102
--- /dev/null
+++ b/xdoctest/dynamic_analysis.pyi
@@ -0,0 +1,33 @@
+from typing import Union
+from os import PathLike
+from types import ModuleType
+from typing import Dict
+import xdoctest
+from types import FrameType
+from typing import Callable
+from typing import Tuple
+from collections.abc import Generator
+from typing import Any
+
+
+def parse_dynamic_calldefs(
+    modpath_or_module: Union[str, PathLike, ModuleType]
+) -> Dict[str, xdoctest.static_analysis.CallDefNode]:
+    ...
+
+
+def get_stack_frame(n: int = 0, strict: bool = True) -> FrameType:
+    ...
+
+
+def get_parent_frame(n: int = 0) -> FrameType:
+    ...
+
+
+def iter_module_doctestables(
+        module: ModuleType) -> Generator[Tuple[str, Callable], None, Any]:
+    ...
+
+
+def is_defined_by_module(item: object, module: ModuleType):
+    ...
diff --git a/xdoctest/exceptions.pyi b/xdoctest/exceptions.pyi
new file mode 100644
index 00000000..8bc4b97d
--- /dev/null
+++ b/xdoctest/exceptions.pyi
@@ -0,0 +1,35 @@
+from _typeshed import Incomplete
+
+
+class MalformedDocstr(Exception):
+    ...
+
+
+class DoctestParseError(Exception):
+    msg: Incomplete
+    string: Incomplete
+    info: Incomplete
+    orig_ex: Incomplete
+
+    def __init__(self,
+                 msg,
+                 string: Incomplete | None = ...,
+                 info: Incomplete | None = ...,
+                 orig_ex: Incomplete | None = ...) -> None:
+        ...
+
+
+class ExitTestException(Exception):
+    ...
+
+
+class IncompleteParseError(SyntaxError):
+    ...
+
+
+class _pytest:
+
+    class outcomes:
+
+        class Skipped(Exception):
+            ...
diff --git a/xdoctest/global_state.pyi b/xdoctest/global_state.pyi
new file mode 100644
index 00000000..59f57469
--- /dev/null
+++ b/xdoctest/global_state.pyi
@@ -0,0 +1,7 @@
+from _typeshed import Incomplete
+
+DEBUG: Incomplete
+DEBUG_PARSER: Incomplete
+DEBUG_CORE: Incomplete
+DEBUG_RUNNER: Incomplete
+DEBUG_DOCTEST: Incomplete
diff --git a/xdoctest/parser.pyi b/xdoctest/parser.pyi
new file mode 100644
index 00000000..cb6077f7
--- /dev/null
+++ b/xdoctest/parser.pyi
@@ -0,0 +1,15 @@
+from _typeshed import Incomplete
+
+INDENT_RE: Incomplete
+NEED_16806_WORKAROUND: Incomplete
+PY2: Incomplete
+
+
+class DoctestParser:
+    simulate_repl: Incomplete
+
+    def __init__(self, simulate_repl: bool = ...) -> None:
+        ...
+
+    def parse(self, string: str, info: dict = None) -> list:
+        ...
diff --git a/xdoctest/plugin.pyi b/xdoctest/plugin.pyi
new file mode 100644
index 00000000..4fc6c301
--- /dev/null
+++ b/xdoctest/plugin.pyi
@@ -0,0 +1,71 @@
+import pytest
+from _pytest._code import code
+from _typeshed import Incomplete
+from collections.abc import Generator
+from typing import Any
+
+
+def monkey_patch_disable_normal_doctest():
+    ...
+
+
+def pytest_addoption(parser):
+    ...
+
+
+def pytest_collect_file(path, parent):
+    ...
+
+
+class ReprFailXDoctest(code.TerminalRepr):
+    reprlocation: Incomplete
+    lines: Incomplete
+
+    def __init__(self, reprlocation, lines) -> None:
+        ...
+
+    def toterminal(self, tw) -> None:
+        ...
+
+
+class XDoctestItem(pytest.Item):
+    cls: Incomplete
+    example: Incomplete
+    obj: Incomplete
+    fixture_request: Incomplete
+
+    def __init__(self, name, parent, example: Incomplete | None = ...) -> None:
+        ...
+
+    def setup(self) -> None:
+        ...
+
+    def runtest(self) -> None:
+        ...
+
+    def repr_failure(self, excinfo):
+        ...
+
+    def reportinfo(self):
+        ...
+
+
+class _XDoctestBase(pytest.Module):
+    ...
+
+
+class XDoctestTextfile(_XDoctestBase):
+    obj: Incomplete
+
+    def collect(self) -> Generator[Any, None, None]:
+        ...
+
+
+class XDoctestModule(_XDoctestBase):
+
+    def collect(self) -> Generator[Any, None, None]:
+        ...
+
+
+def xdoctest_namespace():
+    ...
diff --git a/xdoctest/py.typed b/xdoctest/py.typed
new file mode 100644
index 00000000..e69de29b
diff --git a/xdoctest/runner.pyi b/xdoctest/runner.pyi
new file mode 100644
index 00000000..fdac99fa
--- /dev/null
+++ b/xdoctest/runner.pyi
@@ -0,0 +1,25 @@
+from typing import Callable
+from typing import Union
+from types import ModuleType
+from typing import List
+from typing import Dict
+
+
+def log(msg, verbose) -> None:
+    ...
+
+
+def doctest_callable(func: Callable) -> None:
+    ...
+
+
+def doctest_module(module_identifier: Union[str, ModuleType, None] = None,
+                   command: str = None,
+                   argv: List[str] = None,
+                   exclude: List[str] = ...,
+                   style: str = ...,
+                   verbose: int = None,
+                   config: Dict[str, object] = None,
+                   durations: int = None,
+                   analysis: str = 'auto') -> Dict:
+    ...
diff --git a/xdoctest/static_analysis.pyi b/xdoctest/static_analysis.pyi
new file mode 100644
index 00000000..fad3e109
--- /dev/null
+++ b/xdoctest/static_analysis.pyi
@@ -0,0 +1,106 @@
+from typing import Dict
+from typing import List
+import ast
+from _typeshed import Incomplete
+from collections.abc import Generator
+from typing import Any
+from xdoctest.utils.util_import import is_modname_importable as is_modname_importable, modname_to_modpath as modname_to_modpath, modpath_to_modname as modpath_to_modname, split_modpath as split_modpath
+
+PLAT_IMPL: Incomplete
+HAS_UPDATED_LINENOS: Incomplete
+
+
+class CallDefNode:
+    callname: Incomplete
+    lineno: Incomplete
+    docstr: Incomplete
+    doclineno: Incomplete
+    doclineno_end: Incomplete
+    lineno_end: Incomplete
+    args: Incomplete
+
+    def __init__(self,
+                 callname,
+                 lineno,
+                 docstr,
+                 doclineno,
+                 doclineno_end,
+                 args: Incomplete | None = ...) -> None:
+        ...
+
+
+class TopLevelVisitor(ast.NodeVisitor):
+
+    @classmethod
+    def parse(cls, source):
+        ...
+
+    calldefs: Incomplete
+    source: Incomplete
+    sourcelines: Incomplete
+    assignments: Incomplete
+
+    def __init__(self, source: Incomplete | None = ...) -> None:
+        ...
+
+    def syntax_tree(self):
+        ...
+
+    def process_finished(self, node) -> None:
+        ...
+
+    def visit(self, node) -> None:
+        ...
+
+    def visit_FunctionDef(self, node) -> None:
+        ...
+
+    def visit_ClassDef(self, node) -> None:
+        ...
+
+    def visit_Module(self, node) -> None:
+        ...
+
+    def visit_Assign(self, node) -> None:
+        ...
+
+    def visit_If(self, node) -> None:
+        ...
+
+
+def parse_static_calldefs(source: str = None,
+                          fpath: str = None) -> Dict[str, CallDefNode]:
+    ...
+
+
+def parse_calldefs(source: Incomplete | None = ...,
+                   fpath: Incomplete | None = ...):
+    ...
+
+
+def parse_static_value(key: str, source: str = None, fpath: str = None):
+    ...
+
+
+def package_modpaths(pkgpath: str,
+                     with_pkg: bool = False,
+                     with_mod: bool = True,
+                     followlinks: bool = ...,
+                     recursive: bool = True,
+                     with_libs: bool = False,
+                     check: bool = True) -> Generator[str, None, None]:
+    ...
+
+
+def is_balanced_statement(lines: List[str],
+                          only_tokens: bool = ...,
+                          reraise: int = ...) -> bool:
+    ...
+
+
+def extract_comments(source) -> Generator[Any, None, Any]:
+    ...
+
+
+def six_axt_parse(source_block, filename: str = ..., compatible: bool = ...):
+    ...
diff --git a/xdoctest/utils/util_deprecation.pyi b/xdoctest/utils/util_deprecation.pyi
new file mode 100644
index 00000000..07a0f396
--- /dev/null
+++ b/xdoctest/utils/util_deprecation.pyi
@@ -0,0 +1,11 @@
+from typing import Union
+
+
+def schedule_deprecation(modname: str,
+                         name: str = '?',
+                         type: str = '?',
+                         migration: str = '',
+                         deprecate: Union[str, None] = None,
+                         error: Union[str, None] = None,
+                         remove: Union[str, None] = None) -> None:
+    ...
diff --git a/xdoctest/utils/util_import.py b/xdoctest/utils/util_import.py
index 6884d90f..63b2367f 100644
--- a/xdoctest/utils/util_import.py
+++ b/xdoctest/utils/util_import.py
@@ -207,7 +207,7 @@ def import_module_from_path(modpath, index=-1):
             The default may change to 0 in the future.
 
     Returns:
-        module: the imported module
+        ModuleType: the imported module
 
     References:
         https://stackoverflow.com/questions/67631/import-module-given-path
@@ -325,7 +325,7 @@ def import_module_from_name(modname):
         modname (str):  module name
 
     Returns:
-        module: module
+        ModuleType: module
 
     Example:
         >>> # test with modules that wont be imported in normal circumstances
diff --git a/xdoctest/utils/util_import.pyi b/xdoctest/utils/util_import.pyi
new file mode 100644
index 00000000..2080b71d
--- /dev/null
+++ b/xdoctest/utils/util_import.pyi
@@ -0,0 +1,56 @@
+from os import PathLike
+from types import ModuleType
+from _typeshed import Incomplete
+
+
+def is_modname_importable(modname: str,
+                          sys_path: list = None,
+                          exclude: list = None) -> bool:
+    ...
+
+
+class PythonPathContext:
+    dpath: Incomplete
+    index: Incomplete
+
+    def __init__(self, dpath, index: int = ...) -> None:
+        ...
+
+    def __enter__(self) -> None:
+        ...
+
+    def __exit__(self, type, value, trace) -> None:
+        ...
+
+
+def import_module_from_path(modpath: PathLike, index: int = ...) -> ModuleType:
+    ...
+
+
+def import_module_from_name(modname: str) -> ModuleType:
+    ...
+
+
+def modname_to_modpath(modname: str,
+                       hide_init: bool = True,
+                       hide_main: bool = False,
+                       sys_path: list = None) -> str:
+    ...
+
+
+def normalize_modpath(modpath: PathLike,
+                      hide_init: bool = True,
+                      hide_main: bool = False) -> PathLike:
+    ...
+
+
+def modpath_to_modname(modpath: str,
+                       hide_init: bool = True,
+                       hide_main: bool = False,
+                       check: bool = True,
+                       relativeto: str = None) -> str:
+    ...
+
+
+def split_modpath(modpath: str, check: bool = True) -> tuple:
+    ...
diff --git a/xdoctest/utils/util_misc.pyi b/xdoctest/utils/util_misc.pyi
new file mode 100644
index 00000000..90fb3395
--- /dev/null
+++ b/xdoctest/utils/util_misc.pyi
@@ -0,0 +1,23 @@
+from _typeshed import Incomplete
+
+
+class TempDoctest:
+    modname: Incomplete
+    docstr: Incomplete
+    temp: Incomplete
+    dpath: Incomplete
+    modpath: Incomplete
+
+    def __init__(self, docstr, modname: Incomplete | None = ...) -> None:
+        ...
+
+
+class TempModule:
+    modname: Incomplete
+    module_text: Incomplete
+    temp: Incomplete
+    dpath: Incomplete
+    modpath: Incomplete
+
+    def __init__(self, module_text, modname: Incomplete | None = ...) -> None:
+        ...
diff --git a/xdoctest/utils/util_mixins.pyi b/xdoctest/utils/util_mixins.pyi
new file mode 100644
index 00000000..151044bd
--- /dev/null
+++ b/xdoctest/utils/util_mixins.pyi
@@ -0,0 +1,2 @@
+class NiceRepr:
+    ...
diff --git a/xdoctest/utils/util_notebook.py b/xdoctest/utils/util_notebook.py
index 28631cc7..f6dd4aff 100644
--- a/xdoctest/utils/util_notebook.py
+++ b/xdoctest/utils/util_notebook.py
@@ -152,7 +152,7 @@ def import_notebook_from_path(ipynb_fpath, only_defs=False):
     clean sys.path variables.
 
     Args:
-        ipynb_fpath (str | Path): path to the ipython notebook file to import
+        ipynb_fpath (str | PathLike): path to the ipython notebook file to import
         only_defs (bool, default=False): if True ignores all non-definition
             statements
 
@@ -195,12 +195,12 @@ def execute_notebook(ipynb_fpath, timeout=None, verbose=None):
     Execute an IPython notebook in a separate kernel
 
     Args:
-        ipynb_fpath (str | Path): path to the ipython notebook file to import
+        ipynb_fpath (str | PathLike): path to the ipython notebook file to import
 
     Returns:
-        nb : NotebookNode
+        nbformat.notebooknode.NotebookNode : nb
             The executed notebook.
-        resources : dictionary
+        dict: resources
             Additional resources used in the conversion process.
 
     Example:
diff --git a/xdoctest/utils/util_notebook.pyi b/xdoctest/utils/util_notebook.pyi
new file mode 100644
index 00000000..a6cd23cb
--- /dev/null
+++ b/xdoctest/utils/util_notebook.pyi
@@ -0,0 +1,36 @@
+from typing import Union
+from os import PathLike
+import ast
+from _typeshed import Incomplete
+
+
+class CellDeleter(ast.NodeTransformer):
+
+    def visit(self, node):
+        ...
+
+
+class NotebookLoader:
+    default_options: Incomplete
+    shell: Incomplete
+    path: Incomplete
+    options: Incomplete
+
+    def __init__(self, path: Incomplete | None = ...) -> None:
+        ...
+
+    def load_module(self,
+                    fullname: Incomplete | None = ...,
+                    fpath: Incomplete | None = ...):
+        ...
+
+
+def import_notebook_from_path(ipynb_fpath: Union[str, PathLike],
+                              only_defs: bool = False):
+    ...
+
+
+def execute_notebook(ipynb_fpath: Union[str, PathLike],
+                     timeout: Incomplete | None = ...,
+                     verbose: Incomplete | None = ...) -> dict:
+    ...
diff --git a/xdoctest/utils/util_path.pyi b/xdoctest/utils/util_path.pyi
new file mode 100644
index 00000000..8e0c1fec
--- /dev/null
+++ b/xdoctest/utils/util_path.pyi
@@ -0,0 +1,28 @@
+from _typeshed import Incomplete
+
+
+class TempDir:
+    dpath: Incomplete
+    persist: Incomplete
+
+    def __init__(self, persist: bool = ...) -> None:
+        ...
+
+    def __del__(self) -> None:
+        ...
+
+    def ensure(self):
+        ...
+
+    def cleanup(self) -> None:
+        ...
+
+    def __enter__(self):
+        ...
+
+    def __exit__(self, type_, value, trace) -> None:
+        ...
+
+
+def ensuredir(dpath: str, mode: int = 1023) -> str:
+    ...
diff --git a/xdoctest/utils/util_str.pyi b/xdoctest/utils/util_str.pyi
new file mode 100644
index 00000000..df2939e5
--- /dev/null
+++ b/xdoctest/utils/util_str.pyi
@@ -0,0 +1,33 @@
+from _typeshed import Incomplete
+
+NO_COLOR: Incomplete
+
+
+def strip_ansi(text):
+    ...
+
+
+def color_text(text: str, color: str) -> str:
+    ...
+
+
+def ensure_unicode(text):
+    ...
+
+
+def indent(text: str, prefix: str = '    ') -> str:
+    ...
+
+
+def highlight_code(text: str, lexer_name: str = 'python', **kwargs) -> str:
+    ...
+
+
+def add_line_numbers(source,
+                     start: int = ...,
+                     n_digits: Incomplete | None = ...):
+    ...
+
+
+def codeblock(block_str: str) -> str:
+    ...
diff --git a/xdoctest/utils/util_stream.py b/xdoctest/utils/util_stream.py
index cf614056..6188df87 100644
--- a/xdoctest/utils/util_stream.py
+++ b/xdoctest/utils/util_stream.py
@@ -88,7 +88,7 @@ def write(self, msg):
         if six.PY2:
             from xdoctest.utils.util_str import ensure_unicode
             msg = ensure_unicode(msg)
-        super(TeeStringIO, self).write(msg)
+        return super(TeeStringIO, self).write(msg)
 
     def flush(self):  # nocover
         """
@@ -96,7 +96,7 @@ def flush(self):  # nocover
         """
         if self.redirect is not None:
             self.redirect.flush()
-        super(TeeStringIO, self).flush()
+        return super(TeeStringIO, self).flush()
 
 
 class CaptureStream(object):
diff --git a/xdoctest/utils/util_stream.pyi b/xdoctest/utils/util_stream.pyi
new file mode 100644
index 00000000..3aafbaf1
--- /dev/null
+++ b/xdoctest/utils/util_stream.pyi
@@ -0,0 +1,67 @@
+import io
+from _typeshed import Incomplete
+
+
+class TeeStringIO(io.StringIO):
+    redirect: Incomplete
+    buffer: Incomplete
+
+    def __init__(self, redirect: Incomplete | None = ...) -> None:
+        ...
+
+    def isatty(self):
+        ...
+
+    def fileno(self):
+        ...
+
+    @property
+    def encoding(self):
+        ...
+
+    def write(self, msg):
+        ...
+
+    def flush(self):
+        ...
+
+
+class CaptureStream:
+    ...
+
+
+class CaptureStdout(CaptureStream):
+    enabled: Incomplete
+    suppress: Incomplete
+    orig_stdout: Incomplete
+    cap_stdout: Incomplete
+    text: Incomplete
+    parts: Incomplete
+    started: bool
+
+    def __init__(self,
+                 suppress: bool = ...,
+                 enabled: bool = ...,
+                 **kwargs) -> None:
+        ...
+
+    def log_part(self) -> None:
+        ...
+
+    def start(self) -> None:
+        ...
+
+    def stop(self) -> None:
+        ...
+
+    def __enter__(self):
+        ...
+
+    def __del__(self) -> None:
+        ...
+
+    def close(self) -> None:
+        ...
+
+    def __exit__(self, type_, value, trace):
+        ...

From 1847de66b7ff0cd02b407e482aebfe257e2b3fd2 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 19:24:37 -0400
Subject: [PATCH 22/38] Does 3.4 work?

---
 setup.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/setup.py b/setup.py
index a91ccb02..ee3ed80d 100755
--- a/setup.py
+++ b/setup.py
@@ -221,7 +221,8 @@ def gen_packages_items():
         packages=find_packages('.'),
         # packages=['xdoctest', 'xdoctest.utils', 'xdoctest.docstr'],
         # custom PyPI classifier for pytest plugins
-        python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*',
+        # python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*',
+        python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*',
         package_data={
             'xdoctest': ['py.typed', '*.pyi'],
         },
@@ -242,6 +243,7 @@ def gen_packages_items():
             'Programming Language :: Python :: 3.7',
             'Programming Language :: Python :: 3.6',
             'Programming Language :: Python :: 3.5',
+            'Programming Language :: Python :: 3.4',
             'Programming Language :: Python :: 2.7',
             'Programming Language :: Python :: Implementation :: PyPy',
             'Programming Language :: Python :: Implementation :: CPython',

From 01d2401c2eb6460ea919bc236c3a2dcc84d3bbe8 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 19:39:23 -0400
Subject: [PATCH 23/38] Update docs

---
 .github/workflows/tests.yml                        |  2 +-
 CHANGELOG.md                                       |  3 +++
 docs/source/conf.py                                |  2 +-
 .../xdoctest.docstr.convert_google_to_numpy.rst    |  7 -------
 docs/source/xdoctest.docstr.rst                    |  1 -
 docs/source/xdoctest.global_state.rst              |  7 +++++++
 docs/source/xdoctest.rst                           |  1 +
 docs/source/xdoctest.utils.rst                     |  1 +
 docs/source/xdoctest.utils.util_deprecation.rst    |  7 +++++++
 xdoctest/docstr/docscrape_google.py                |  4 ++--
 xdoctest/runner.py                                 | 14 +++++++-------
 11 files changed, 30 insertions(+), 19 deletions(-)
 delete mode 100644 docs/source/xdoctest.docstr.convert_google_to_numpy.rst
 create mode 100644 docs/source/xdoctest.global_state.rst
 create mode 100644 docs/source/xdoctest.utils.util_deprecation.rst

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 8b91d9b6..9c33b588 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -100,7 +100,7 @@ jobs:
         - macOS-latest
         python-version:
         - '2.7'
-        #- '3.4'
+        - '3.4'
         - '3.5'
         - '3.6'
         - '3.7'
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a661485a..39558f65 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,9 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## Version 1.0.1 - Unreleased
 
+### Added
+* Add type stubs
+
 ### Fixed
 * Corner case bug in error reporting
 * Doctests that never run any code are now correctly marked as skipped 
diff --git a/docs/source/conf.py b/docs/source/conf.py
index a2a23784..a9edb823 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -147,7 +147,7 @@ def visit_Assign(self, node):
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
diff --git a/docs/source/xdoctest.docstr.convert_google_to_numpy.rst b/docs/source/xdoctest.docstr.convert_google_to_numpy.rst
deleted file mode 100644
index 3c465376..00000000
--- a/docs/source/xdoctest.docstr.convert_google_to_numpy.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-xdoctest.docstr.convert\_google\_to\_numpy module
-=================================================
-
-.. automodule:: xdoctest.docstr.convert_google_to_numpy
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/xdoctest.docstr.rst b/docs/source/xdoctest.docstr.rst
index 7c5cc076..c4cfe2df 100644
--- a/docs/source/xdoctest.docstr.rst
+++ b/docs/source/xdoctest.docstr.rst
@@ -7,7 +7,6 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   xdoctest.docstr.convert_google_to_numpy
    xdoctest.docstr.docscrape_google
    xdoctest.docstr.docscrape_numpy
 
diff --git a/docs/source/xdoctest.global_state.rst b/docs/source/xdoctest.global_state.rst
new file mode 100644
index 00000000..4d82b7aa
--- /dev/null
+++ b/docs/source/xdoctest.global_state.rst
@@ -0,0 +1,7 @@
+xdoctest.global\_state module
+=============================
+
+.. automodule:: xdoctest.global_state
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/xdoctest.rst b/docs/source/xdoctest.rst
index 4f7e1f97..c0410aba 100644
--- a/docs/source/xdoctest.rst
+++ b/docs/source/xdoctest.rst
@@ -25,6 +25,7 @@ Submodules
    xdoctest.doctest_part
    xdoctest.dynamic_analysis
    xdoctest.exceptions
+   xdoctest.global_state
    xdoctest.parser
    xdoctest.plugin
    xdoctest.runner
diff --git a/docs/source/xdoctest.utils.rst b/docs/source/xdoctest.utils.rst
index f123040c..21579a5d 100644
--- a/docs/source/xdoctest.utils.rst
+++ b/docs/source/xdoctest.utils.rst
@@ -7,6 +7,7 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
+   xdoctest.utils.util_deprecation
    xdoctest.utils.util_import
    xdoctest.utils.util_misc
    xdoctest.utils.util_mixins
diff --git a/docs/source/xdoctest.utils.util_deprecation.rst b/docs/source/xdoctest.utils.util_deprecation.rst
new file mode 100644
index 00000000..cf83cc7a
--- /dev/null
+++ b/docs/source/xdoctest.utils.util_deprecation.rst
@@ -0,0 +1,7 @@
+xdoctest.utils.util\_deprecation module
+=======================================
+
+.. automodule:: xdoctest.utils.util_deprecation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/xdoctest/docstr/docscrape_google.py b/xdoctest/docstr/docscrape_google.py
index c2403dc2..18b0b3bc 100644
--- a/xdoctest/docstr/docscrape_google.py
+++ b/xdoctest/docstr/docscrape_google.py
@@ -11,8 +11,8 @@
     * https://pypi.org/project/numpydoc/
 
 References:
-    [GoogleStyleDocs1] https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google
-    [GoogleStyleDocs2] http://www.sphinx-doc.org/en/stable/ext/example_google.html#example-google
+    .. [GoogleStyleDocs1] https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google
+    .. [GoogleStyleDocs2] http://www.sphinx-doc.org/en/stable/ext/example_google.html#example-google
 """
 from __future__ import absolute_import, division, print_function, unicode_literals
 import re
diff --git a/xdoctest/runner.py b/xdoctest/runner.py
index f1dba062..2c39fe32 100644
--- a/xdoctest/runner.py
+++ b/xdoctest/runner.py
@@ -110,15 +110,15 @@ def doctest_module(module_identifier=None, command=None, argv=None, exclude=[],
             The name of / path to the module, or the live module itself.
             If not specified, dynamic analysis will be used to introspect the
             module that called this function and that module will be used.
-            This can also contain the callname followed by the `::` token.
+            This can also contain the callname followed by the ``::`` token.
 
         command (str):
             determines which doctests to run.
             if command is None, this is determined by parsing sys.argv
             Value values are
-                'all' - find and run all tests in a module
-                'list' - list the tests in a module
-                'dump' - dumps tests to stdout
+            'all' - find and run all tests in a module
+            'list' - list the tests in a module
+            'dump' - dumps tests to stdout
 
         argv (List[str], default=None):
             if specified, command line flags that might influence beharior.
@@ -128,9 +128,9 @@ def doctest_module(module_identifier=None, command=None, argv=None, exclude=[],
 
         verbose (int, default=None):
             Verbosity level.
-                0 - disables all text
-                1 - minimal printing
-                3 - verbose printing
+            0 - disables all text
+            1 - minimal printing
+            3 - verbose printing
 
         exclude (List[str]):
             ignores any modname matching any of these glob-like patterns

From 26f39e693229e9461c6ef75b2a5c1e9dec703161 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 20:48:24 -0400
Subject: [PATCH 24/38] Checker types

---
 xdoctest/checker.py  | 98 +++++++++++++++++++++++++++++++++++++++++++-
 xdoctest/checker.pyi | 46 ++++++++++++++-------
 2 files changed, 128 insertions(+), 16 deletions(-)

diff --git a/xdoctest/checker.py b/xdoctest/checker.py
index 2be424a2..e7f58e2c 100644
--- a/xdoctest/checker.py
+++ b/xdoctest/checker.py
@@ -74,6 +74,7 @@ def check_got_vs_want(want, got_stdout, got_eval=constants.NOT_EVALED,
         want (str): target to match against
         got_stdout (str): output from stdout
         got_eval (str): output from an eval statement.
+        runstate (xdoctest.directive.RuntimeState | None): current state
 
     Raises:
         GotWantException - If the "got" differs from this parts want.
@@ -111,6 +112,13 @@ def check_got_vs_want(want, got_stdout, got_eval=constants.NOT_EVALED,
 
 
 def _strip_exception_details(msg):
+    """
+    Args:
+        msg (str):
+
+    Returns:
+        str:
+    """
     # Support for IGNORE_EXCEPTION_DETAIL.
     # Get rid of everything except the exception name; in particular, drop
     # the possibly dotted module path (if any) and the exception message (if
@@ -138,6 +146,13 @@ def _strip_exception_details(msg):
 
 
 def extract_exc_want(want):
+    """
+    Args:
+        want (str):
+
+    Returns:
+        str:
+    """
     want_ = utils.codeblock(want)
     m = _EXCEPTION_RE.search(want_)
     exc_want = m.group('msg') if m else None
@@ -148,8 +163,16 @@ def check_exception(exc_got, want, runstate=None):
     """
     Checks want against an exception
 
+    Args:
+        exc_got (str): the exception message
+        want (str): target to match against
+        runstate (xdoctest.directive.RuntimeState | None): current state
+
     Raises:
         GotWantException - If the "got" differs from this parts want.
+
+    Returns:
+        bool: True if got matches want
     """
     exc_want = extract_exc_want(want)
     if exc_want is None:
@@ -177,7 +200,16 @@ def check_exception(exc_got, want, runstate=None):
 
 def check_output(got, want, runstate=None):
     """
-    Does the actual comparison between `got` and `want`
+    Does the actual comparison between `got` and `want` as long as the check is
+    enabled.
+
+    Args:
+        got (str): text produced by the test
+        want (str): target to match against
+        runstate (xdoctest.directive.RuntimeState | None): current state
+
+    Returns:
+        bool: True if got matches want or if the check is disabled
     """
     if not want:  # nocover
         return True
@@ -195,6 +227,17 @@ def check_output(got, want, runstate=None):
 
 
 def _check_match(got, want, runstate):
+    """
+    Does the actual comparison between `got` and `want`
+
+    Args:
+        got (str): normalized text produced by the test
+        want (str): normalized target to match against
+        runstate (xdoctest.directive.RuntimeState | None): current state
+
+    Returns:
+        bool: True if got matches want
+    """
     if got == want:
         return True
 
@@ -211,6 +254,13 @@ def _ellipsis_match(got, want):
 
     Worst-case linear-time ellipsis matching.
 
+    Args:
+        got (str):
+        want (str):
+
+    Returns:
+        bool: True if the text matches according to the ellipsis rule
+
     CommandLine:
         python -m xdoctest.checker _ellipsis_match
 
@@ -283,14 +333,29 @@ def _ellipsis_match(got, want):
 
 def normalize(got, want, runstate=None):
     r"""
+    Normalizes the got and want string based on the runtime state.
+
     Adapted from doctest_nose_plugin.py from the nltk project:
         https://github.com/nltk/nltk
 
     Further extended to also support byte literals.
 
+    Args:
+        got (str): unnormalized got str.
+        want (str): unnormalized want str.
+        runstate (xdoctest.directive.RuntimeState | None): current state
+
+    Returns:
+        Tuple[str, str]:
+            The normalized got and want str
+
     Example:
+        >>> from xdoctest.checker import *  # NOQA
         >>> want = "...\n(0, 2, {'weight': 1})\n(0, 3, {'weight': 2})"
         >>> got = "(0, 2, {'weight': 1})\n(0, 3, {'weight': 2})"
+        >>> normalize(got, want)
+        ("(0, 2, {'weight': 1}) (0, 3, {'weight': 2})",
+         "... (0, 2, {'weight': 1}) (0, 3, {'weight': 2})")
     """
     if runstate is None:
         runstate = directive.RuntimeState()
@@ -372,6 +437,11 @@ class ExtractGotReprException(AssertionError):
     Exception used when we are unable to extract a string "got"
     """
     def __init__(self, msg, orig_ex):
+        """
+        Args:
+            msg (str): The exception message
+            orig_ex (Exception): The parent exception
+        """
         super(ExtractGotReprException, self).__init__(msg)
         self.orig_ex = orig_ex
 
@@ -380,9 +450,14 @@ class GotWantException(AssertionError):
     """
     Exception used when the "got" output of a doctest differs from the expected
     "want" output.
-
     """
     def __init__(self, msg, got, want):
+        """
+        Args:
+            msg (str): The exception message
+            got (str): The unnormalized got str
+            want (str): The unnormalized want str
+        """
         super(GotWantException, self).__init__(msg)
         self.got = got
         self.want = want
@@ -412,6 +487,13 @@ def output_difference(self, runstate=None, colored=True):
         for a given example (`example`) and the actual output (`got`).
         The `runstate` contains option flags used to compare `want` and `got`.
 
+        Args:
+            runstate (xdoctest.directive.RuntimeState | None): current state
+            colored (bool): if the text should be colored
+
+        Returns:
+            str: formatted difference text
+
         Note:
             This does not check if got matches want, it only outputs the raw
             differences. Got/Want normalization may make the differences appear
@@ -493,6 +575,12 @@ def output_difference(self, runstate=None, colored=True):
     def output_repr_difference(self, runstate=None):
         """
         Constructs a repr difference with minimal normalization.
+
+        Args:
+            runstate (xdoctest.directive.RuntimeState | None): current state
+
+        Returns:
+            str: formatted repr difference text
         """
         minimal_got = self.got.rstrip()
         minimal_want = self.want.rstrip()
@@ -517,6 +605,12 @@ def output_repr_difference(self, runstate=None):
 
 def remove_blankline_marker(text):
     r"""
+    Args:
+        text (str): input text
+
+    Returns:
+        str: output text
+
     Example:
         >>> text1 = 'foo\n{}\nbar'.format(BLANKLINE_MARKER)
         >>> text2 = '{}\nbar'.format(BLANKLINE_MARKER)
diff --git a/xdoctest/checker.pyi b/xdoctest/checker.pyi
index 9b2e5311..3a24e38e 100644
--- a/xdoctest/checker.pyi
+++ b/xdoctest/checker.pyi
@@ -1,3 +1,6 @@
+from typing import Union
+import xdoctest
+from typing import Tuple
 from _typeshed import Incomplete
 
 unicode_literal_re: Incomplete
@@ -10,48 +13,63 @@ TRAILING_WS: Incomplete
 def check_got_vs_want(want: str,
                       got_stdout: str,
                       got_eval: str = ...,
-                      runstate: Incomplete | None = ...):
+                      runstate: Union[xdoctest.directive.RuntimeState,
+                                      None] = None):
     ...
 
 
-def extract_exc_want(want):
+def extract_exc_want(want: str) -> str:
     ...
 
 
-def check_exception(exc_got, want, runstate: Incomplete | None = ...):
+def check_exception(
+        exc_got: str,
+        want: str,
+        runstate: Union[xdoctest.directive.RuntimeState, None] = None) -> bool:
     ...
 
 
-def check_output(got, want, runstate: Incomplete | None = ...):
+def check_output(
+        got: str,
+        want: str,
+        runstate: Union[xdoctest.directive.RuntimeState, None] = None) -> bool:
     ...
 
 
-def normalize(got, want, runstate: Incomplete | None = ...):
+def normalize(
+    got: str,
+    want: str,
+    runstate: Union[xdoctest.directive.RuntimeState, None] = None
+) -> Tuple[str, str]:
     ...
 
 
 class ExtractGotReprException(AssertionError):
-    orig_ex: Incomplete
+    orig_ex: Exception
 
-    def __init__(self, msg, orig_ex) -> None:
+    def __init__(self, msg: str, orig_ex: Exception) -> None:
         ...
 
 
 class GotWantException(AssertionError):
-    got: Incomplete
-    want: Incomplete
+    got: str
+    want: str
 
-    def __init__(self, msg, got, want) -> None:
+    def __init__(self, msg: str, got: str, want: str) -> None:
         ...
 
     def output_difference(self,
-                          runstate: Incomplete | None = ...,
-                          colored: bool = ...):
+                          runstate: Union[xdoctest.directive.RuntimeState,
+                                          None] = None,
+                          colored: bool = True) -> str:
         ...
 
-    def output_repr_difference(self, runstate: Incomplete | None = ...):
+    def output_repr_difference(
+            self,
+            runstate: Union[xdoctest.directive.RuntimeState,
+                            None] = None) -> str:
         ...
 
 
-def remove_blankline_marker(text):
+def remove_blankline_marker(text: str) -> str:
     ...

From 6d81cd42497e2d1a97475318a3cde0884cf3f077 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 20:59:48 -0400
Subject: [PATCH 25/38] wip

---
 .github/workflows/tests.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 9c33b588..8b91d9b6 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -100,7 +100,7 @@ jobs:
         - macOS-latest
         python-version:
         - '2.7'
-        - '3.4'
+        #- '3.4'
         - '3.5'
         - '3.6'
         - '3.7'

From d777268a01650332ef1b2130a2abffde221c6915 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 21:53:19 -0400
Subject: [PATCH 26/38] Defined types in most cases

---
 xdoctest/__main__.py           |  6 ++-
 xdoctest/__main__.pyi          |  5 +-
 xdoctest/directive.py          | 55 +++++++++++++++++++-
 xdoctest/directive.pyi         | 43 ++++++++--------
 xdoctest/doctest_example.py    | 94 +++++++++++++++++++++++++++++++---
 xdoctest/doctest_example.pyi   | 71 +++++++++++++------------
 xdoctest/doctest_part.py       | 64 ++++++++++++++++++++---
 xdoctest/doctest_part.pyi      | 45 ++++++++--------
 xdoctest/exceptions.py         |  7 +++
 xdoctest/exceptions.pyi        | 19 +++----
 xdoctest/global_state.py       |  7 +++
 xdoctest/parser.py             | 11 +++-
 xdoctest/parser.pyi            | 14 +++--
 xdoctest/plugin.py             | 36 +++++++++++++
 xdoctest/plugin.pyi            | 25 ++++++---
 xdoctest/runner.py             | 13 +++--
 xdoctest/runner.pyi            | 11 ++--
 xdoctest/static_analysis.py    | 62 +++++++++++++++++++++-
 xdoctest/static_analysis.pyi   | 37 +++++++------
 xdoctest/utils/util_str.py     | 22 +++++++-
 xdoctest/utils/util_str.pyi    | 12 +++--
 xdoctest/utils/util_stream.pyi |  3 +-
 22 files changed, 511 insertions(+), 151 deletions(-)

diff --git a/xdoctest/__main__.py b/xdoctest/__main__.py
index dd3223f2..f4b02e7d 100644
--- a/xdoctest/__main__.py
+++ b/xdoctest/__main__.py
@@ -15,13 +15,15 @@
 
     xdoctest -m xdoctest.demo
     xdoctest ~/code/xdoctest/xdoctest/demo.py
+    python -m xdoctest xdoctest all
+    python -m xdoctest networkx all --options=+IGNORE_WHITESPACE
 """
 
 
 def main(argv=None):
     """
-    python -m xdoctest xdoctest all
-    python -m xdoctest networkx all --options=+IGNORE_WHITESPACE
+    Args:
+        argv (List[str] | None):
     """
     import argparse
     import xdoctest
diff --git a/xdoctest/__main__.pyi b/xdoctest/__main__.pyi
index cbad04cb..af9cafae 100644
--- a/xdoctest/__main__.pyi
+++ b/xdoctest/__main__.pyi
@@ -1,5 +1,6 @@
-from _typeshed import Incomplete
+from typing import Union
+from typing import List
 
 
-def main(argv: Incomplete | None = ...):
+def main(argv: Union[List[str], None] = None):
     ...
diff --git a/xdoctest/directive.py b/xdoctest/directive.py
index bce6ff7e..d20a3c97 100644
--- a/xdoctest/directive.py
+++ b/xdoctest/directive.py
@@ -235,22 +235,42 @@ class RuntimeState(utils.NiceRepr):
         })>
     """
     def __init__(self, default_state=None):
+        """
+        Args:
+            default_state (None | dict): starting default state, if unspecified
+                falls back to the global DEFAULT_RUNTIME_STATE
+        """
         self._global_state = copy.deepcopy(DEFAULT_RUNTIME_STATE)
         if default_state:
             self._global_state.update(default_state)
         self._inline_state = {}
 
     def to_dict(self):
+        """
+        Returns:
+            OrderedDict
+        """
         state = self._global_state.copy()
         state.update(self._inline_state)
         state = OrderedDict(sorted(state.items()))
         return state
 
     def __nice__(self):
+        """
+        Returns:
+            str
+        """
         parts = ['{}: {}'.format(*item) for item in self.to_dict().items()]
         return ('{' + ', '.join(parts) + '}')
 
     def __getitem__(self, key):
+        """
+        Args:
+            key (str):
+
+        Returns:
+            Any
+        """
         if key not in self._global_state:
             raise KeyError('Unknown key: {}'.format(key))
         if key in self._inline_state:
@@ -259,12 +279,21 @@ def __getitem__(self, key):
             return self._global_state[key]
 
     def __setitem__(self, key, value):
+        """
+        Args:
+            key (str):
+            value (Any):
+        """
         if key not in self._global_state:
             raise KeyError('Unknown key: {}'.format(key))
         self._global_state[key] = value
 
     def set_report_style(self, reportchoice, state=None):
         """
+        Args:
+            reportchoice (str): name of report style
+            state (None | Dict): if unspecified defaults to the global state
+
         Example:
             >>> from xdoctest.directive import *
             >>> runstate = RuntimeState()
@@ -286,8 +315,9 @@ def update(self, directives):
         Update the runtime state given a set of directives
 
         Args:
-            directives (List[Directive]): list of directives. The ``effects``
-                method is used to update this object.
+            directives (List[Directive]):
+                list of directives. The ``effects`` method is used to update
+                this object.
         """
         # Clear the previous inline state
         self._inline_state.clear()
@@ -327,6 +357,13 @@ class Directive(utils.NiceRepr):
     Directives modify the runtime state.
     """
     def __init__(self, name, positive=True, args=[], inline=None):
+        """
+        Args:
+            name (str):
+            positive (bool):
+            args (List[str]):
+            inline (bool | None): True if this is an inline directive
+        """
         self.name = name
         self.args = args
         self.inline = inline
@@ -429,6 +466,10 @@ def extract(cls, text):
                                 yield directive
 
     def __nice__(self):
+        """
+        Returns:
+            str
+        """
         prefix = ['-', '+'][int(self.positive)]
         if self.args:
             argstr = ', '.join(self.args)
@@ -570,6 +611,12 @@ def _split_opstr(optstr):
     """
     Simplified balanced paren logic to only split commas outside of parens
 
+    Args:
+        opstr (str):
+
+    Returns:
+        List[str]
+
     Example:
         >>> optstr = '+FOO, REQUIRES(foo,bar), +ELLIPSIS'
         >>> _split_opstr(optstr)
@@ -757,6 +804,10 @@ def parse_directive_optstr(optpart, inline=None):
         may contain one paren enclosed argument (experimental)
         all spaces are ignored
 
+    Args:
+        optpart (str):
+        inline (None | bool):
+
     Returns:
         Directive: the parsed directive
 
diff --git a/xdoctest/directive.pyi b/xdoctest/directive.pyi
index 3689a866..7971c054 100644
--- a/xdoctest/directive.pyi
+++ b/xdoctest/directive.pyi
@@ -1,8 +1,11 @@
-from typing import List
+from typing import Union
 from typing import Dict
+from collections import OrderedDict
+from typing import Any
+from typing import List
 from _typeshed import Incomplete
 from collections.abc import Generator
-from typing import NamedTuple
+from typing import Any, NamedTuple
 from xdoctest import utils
 
 
@@ -21,24 +24,24 @@ class Effect(NamedTuple):
 
 class RuntimeState(utils.NiceRepr):
 
-    def __init__(self, default_state: Incomplete | None = ...) -> None:
+    def __init__(self, default_state: Union[None, dict] = None) -> None:
         ...
 
-    def to_dict(self):
+    def to_dict(self) -> OrderedDict:
         ...
 
-    def __nice__(self):
+    def __nice__(self) -> str:
         ...
 
-    def __getitem__(self, key):
+    def __getitem__(self, key: str) -> Any:
         ...
 
-    def __setitem__(self, key, value) -> None:
+    def __setitem__(self, key: str, value: Any) -> None:
         ...
 
     def set_report_style(self,
-                         reportchoice,
-                         state: Incomplete | None = ...) -> None:
+                         reportchoice: str,
+                         state: Union[None, Dict] = None) -> None:
         ...
 
     def update(self, directives: List[Directive]) -> None:
@@ -46,23 +49,23 @@ class RuntimeState(utils.NiceRepr):
 
 
 class Directive(utils.NiceRepr):
-    name: Incomplete
-    args: Incomplete
-    inline: Incomplete
-    positive: Incomplete
+    name: str
+    args: List[str]
+    inline: Union[bool, None]
+    positive: bool
 
     def __init__(self,
-                 name,
-                 positive: bool = ...,
-                 args=...,
-                 inline: Incomplete | None = ...) -> None:
+                 name: str,
+                 positive: bool = True,
+                 args: List[str] = ...,
+                 inline: Union[bool, None] = None) -> None:
         ...
 
     @classmethod
     def extract(cls, text: str) -> Generator[Directive, None, None]:
         ...
 
-    def __nice__(self):
+    def __nice__(self) -> str:
         ...
 
     def effect(self,
@@ -81,6 +84,6 @@ DIRECTIVE_PATTERNS: Incomplete
 DIRECTIVE_RE: Incomplete
 
 
-def parse_directive_optstr(optpart,
-                           inline: Incomplete | None = ...) -> Directive:
+def parse_directive_optstr(optpart: str,
+                           inline: Union[None, bool] = None) -> Directive:
     ...
diff --git a/xdoctest/doctest_example.py b/xdoctest/doctest_example.py
index e50236f4..4afe17e2 100644
--- a/xdoctest/doctest_example.py
+++ b/xdoctest/doctest_example.py
@@ -129,6 +129,14 @@ def str_lower(x):
             add_argument(*alias, **kw)
 
     def getvalue(self, key, given=None):
+        """
+        Args:
+            key (str): The configuration key
+            given (Any): A user override
+
+        Returns:
+            Any: if given is None returns the configured value
+        """
         if given is None:
             return self[key]
         else:
@@ -144,17 +152,17 @@ class DocTest(object):
         docsrc (str):
             doctest source code
 
-        modpath (str | PathLike, default=None):
+        modpath (str | PathLike):
             module the source was read from
 
-        callname (str, default=None):
+        callname (str):
             name of the function/method/class/module being tested
 
-        num (int, default=0):
+        num (int):
             the index of the doctest in the docstring. (i.e. this object
             refers to the num-th doctest within a docstring)
 
-        lineno (int, default=1):
+        lineno (int):
             The line (starting from 1) in the file that the doctest begins on.
             (i.e. if you were to go to this line in the file, the first line of
             the doctest should be on this line).
@@ -163,11 +171,11 @@ class DocTest(object):
             Typically the same as modpath, only specified for non-python files
             (e.g. rst files).
 
-        block_type (str, default=None):
+        block_type (str | None):
             Hint indicating the type of docstring block. Can be ('Example',
             'Doctest', 'Script', 'Benchmark', 'zero-arg', etc..).
 
-        mode (str, default='pytest'):
+        mode (str):
             Hint at what created / is running this doctest. This impacts
             how results are presented and what doctests are skipped.
 
@@ -199,6 +207,17 @@ class DocTest(object):
 
     def __init__(self, docsrc, modpath=None, callname=None, num=0,
                  lineno=1, fpath=None, block_type=None, mode='pytest'):
+        """
+        Args:
+            docsrc (str): the text of the doctest
+            modpath (str | PathLike | None):
+            callname (str | None):
+            num (int):
+            lineno (int):
+            fpath (str | None):
+            block_type (str | None):
+            mode (str):
+        """
         import types
         # if we know the google block type it is recorded
         self.block_type = block_type
@@ -254,6 +273,10 @@ def __init__(self, docsrc, modpath=None, callname=None, num=0,
         self.mode = mode
 
     def __nice__(self):
+        """
+        Returns:
+            str
+        """
         parts = []
         parts.append(self.modname)
         parts.append('%s:%s' % (self.callname, self.num))
@@ -262,11 +285,19 @@ def __nice__(self):
         return ' '.join(parts)
 
     def __repr__(self):
+        """
+        Returns:
+            str
+        """
         classname = self.__class__.__name__
         devnice = self.__nice__()
         return '<%s(%s) at %s>' % (classname, devnice, hex(id(self)))
 
     def __str__(self):
+        """
+        Returns:
+            str
+        """
         classname = self.__class__.__name__
         devnice = self.__nice__()
         return '<%s(%s)>' % (classname, devnice)
@@ -297,6 +328,8 @@ def is_disabled(self, pytest=False):
             indicate what the replacement strategy is. Then raise an error for
             several more versions before finally removing this code.
 
+        Returns:
+            bool:
         """
         disable_patterns = [
             r'>>>\s*#\s*DISABLE',
@@ -319,6 +352,9 @@ def is_disabled(self, pytest=False):
     def unique_callname(self):
         """
         A key that references this doctest given its module
+
+        Returns:
+            str
         """
         return self.callname + ':' + str(self.num)
 
@@ -326,6 +362,9 @@ def unique_callname(self):
     def node(self):
         """
         A key that references this doctest within pytest
+
+        Returns:
+            str
         """
         return self.modpath + '::' + self.callname + ':' + str(self.num)
 
@@ -333,6 +372,9 @@ def node(self):
     def valid_testnames(self):
         """
         A set of callname and unique_callname
+
+        Returns:
+            Set[str]
         """
         return {
             self.callname,
@@ -342,6 +384,9 @@ def valid_testnames(self):
     def wants(self):
         """
         Returns a list of the populated wants
+
+        Yields:
+            str
         """
         self._parse()
         for part in self._parts:
@@ -352,6 +397,14 @@ def format_parts(self, linenos=True, colored=None, want=True,
                      offset_linenos=None, prefix=True):
         """
         Used by :func:`format_src`
+
+        Args:
+            linenos (bool): show line numbers
+            colored (bool | None): pygmentize the code
+            want (bool): include the want value if it exists
+            offset_linenos (bool): if True include the line offset relative to
+                the source file
+            prefix (bool): if False, exclude the doctest ``>>> `` prefix
         """
         self._parse()
         colored = self.config.getvalue('colored', colored)
@@ -394,6 +447,9 @@ def format_src(self, linenos=True, colored=None, want=True,
 
             prefix (bool): if False, exclude the doctest `>>> ` prefix
 
+        Returns:
+            str
+
         Example:
             >>> from xdoctest.core import *
             >>> from xdoctest import core
@@ -415,6 +471,9 @@ def _parse(self):
         """
         Divide the given string into examples and intervening text.
 
+        Returns:
+            None
+
         Example:
             >>> s = 'I am a dummy example with three parts'
             >>> x = 10
@@ -467,6 +526,9 @@ def _import_module(self):
         """
         After this point we are in dynamic analysis mode, in most cases
         xdoctest should have been in static-analysis-only mode.
+
+        Returns:
+            None
         """
         if self.module is None:
             if not self.modname.startswith('<'):
@@ -501,6 +563,9 @@ def _extract_future_flags(namespace):
         """
         Return the compiler-flags associated with the future features that
         have been imported into the given namespace (i.e. globals).
+
+        Returns:
+            int
         """
         compileflags = 0
         for key in __future__.all_feature_names:
@@ -522,6 +587,10 @@ def _test_globals(self):
         return test_globals, compileflags
 
     def anything_ran(self):
+        """
+        Returns:
+            bool
+        """
         # If everything was skipped, then there will be no stdout
         return len(self.logged_stdout) > 0
 
@@ -837,6 +906,9 @@ def _pre_run(self, verbose):
     def failed_line_offset(self):
         """
         Determine which line in the doctest failed.
+
+        Returns:
+            int | None
         """
         if self.exc_info is None:
             return None
@@ -857,6 +929,10 @@ def failed_line_offset(self):
             return offset
 
     def failed_lineno(self):
+        """
+        Returns:
+            int | None
+        """
         offset = self.failed_line_offset()
         if offset is None:
             return None
@@ -869,6 +945,12 @@ def repr_failure(self, with_tb=True):
         r"""
         Constructs lines detailing information about a failed doctest
 
+        Args:
+            with_tb (bool): if True include the traceback
+
+        Returns:
+            List[str]
+
         CommandLine:
             python -m xdoctest.core DocTest.repr_failure:0
             python -m xdoctest.core DocTest.repr_failure:1
diff --git a/xdoctest/doctest_example.pyi b/xdoctest/doctest_example.pyi
index 732a19f0..3782977b 100644
--- a/xdoctest/doctest_example.pyi
+++ b/xdoctest/doctest_example.pyi
@@ -1,4 +1,9 @@
+from typing import Any
+from typing import Union
+from os import PathLike
+from typing import Set
 from typing import Dict
+from typing import List
 from _typeshed import Incomplete
 from collections.abc import Generator
 from typing import Any
@@ -11,7 +16,7 @@ class DoctestConfig(dict):
     def __init__(self, *args, **kwargs) -> None:
         ...
 
-    def getvalue(self, key, given: Incomplete | None = ...):
+    def getvalue(self, key: str, given: Any = None) -> Any:
         ...
 
 
@@ -20,16 +25,17 @@ class DocTest:
     UNKNOWN_MODPATH: str
     UNKNOWN_CALLNAME: str
     UNKNOWN_FPATH: str
-    block_type: Incomplete
+    docsrc: str
+    modpath: Union[str, PathLike]
+    callname: str
+    num: int
+    lineno: int
+    fpath: PathLike
+    block_type: Union[str, None]
+    mode: str
     config: Incomplete
     module: Incomplete
-    modpath: Incomplete
-    fpath: Incomplete
     modname: Incomplete
-    callname: Incomplete
-    docsrc: Incomplete
-    lineno: Incomplete
-    num: Incomplete
     failed_tb_lineno: Incomplete
     exc_info: Incomplete
     failed_part: Incomplete
@@ -37,46 +43,45 @@ class DocTest:
     logged_evals: Incomplete
     logged_stdout: Incomplete
     global_namespace: Incomplete
-    mode: Incomplete
 
     def __init__(self,
-                 docsrc,
-                 modpath: Incomplete | None = ...,
-                 callname: Incomplete | None = ...,
-                 num: int = ...,
-                 lineno: int = ...,
-                 fpath: Incomplete | None = ...,
-                 block_type: Incomplete | None = ...,
-                 mode: str = ...) -> None:
+                 docsrc: str,
+                 modpath: Union[str, PathLike, None] = None,
+                 callname: Union[str, None] = None,
+                 num: int = 0,
+                 lineno: int = 1,
+                 fpath: Union[str, None] = None,
+                 block_type: Union[str, None] = None,
+                 mode: str = 'pytest') -> None:
         ...
 
-    def __nice__(self):
+    def __nice__(self) -> str:
         ...
 
-    def is_disabled(self, pytest: bool = ...):
+    def is_disabled(self, pytest: bool = ...) -> bool:
         ...
 
     @property
-    def unique_callname(self):
+    def unique_callname(self) -> str:
         ...
 
     @property
-    def node(self):
+    def node(self) -> str:
         ...
 
     @property
-    def valid_testnames(self):
+    def valid_testnames(self) -> Set[str]:
         ...
 
-    def wants(self) -> Generator[Any, None, None]:
+    def wants(self) -> Generator[str, None, None]:
         ...
 
     def format_parts(self,
-                     linenos: bool = ...,
-                     colored: Incomplete | None = ...,
-                     want: bool = ...,
-                     offset_linenos: Incomplete | None = ...,
-                     prefix: bool = ...) -> Generator[Any, None, None]:
+                     linenos: bool = True,
+                     colored: Union[bool, None] = None,
+                     want: bool = True,
+                     offset_linenos: bool = None,
+                     prefix: bool = True) -> Generator[Any, None, None]:
         ...
 
     def format_src(self,
@@ -84,10 +89,10 @@ class DocTest:
                    colored: bool = None,
                    want: bool = True,
                    offset_linenos: bool = None,
-                   prefix: bool = True):
+                   prefix: bool = True) -> str:
         ...
 
-    def anything_ran(self):
+    def anything_ran(self) -> bool:
         ...
 
     def run(self, verbose: int = None, on_error: str = None) -> Dict:
@@ -97,11 +102,11 @@ class DocTest:
     def cmdline(self) -> str:
         ...
 
-    def failed_line_offset(self):
+    def failed_line_offset(self) -> int | None:
         ...
 
-    def failed_lineno(self):
+    def failed_lineno(self) -> int | None:
         ...
 
-    def repr_failure(self, with_tb: bool = ...):
+    def repr_failure(self, with_tb: bool = True) -> List[str]:
         ...
diff --git a/xdoctest/doctest_part.py b/xdoctest/doctest_part.py
index 04922536..be39a999 100644
--- a/xdoctest/doctest_part.py
+++ b/xdoctest/doctest_part.py
@@ -26,34 +26,55 @@ class DoctestPart(object):
     If a want statement is defined, it is stored here.
 
     Attributes:
-        exec_lines (list): executable lines in this part
-        want_lines (list): lines that the result of the execution should match
+        exec_lines (List[str]): executable lines in this part
+        want_lines (List[str] | None): lines that the result of the execution should match
         line_offset (int): line number relative to the start of the doctest
-        orig_lines (list): the original text parsed into exec and want
-        _directives (list): directives that this part will apply before being run
-        partno (int): identifies the part number in the larger example
+        orig_lines (List[str] | None): the original text parsed into exec and want
+        _directives (list | None): directives that this part will apply before being run
+        partno (int | None): identifies the part number in the larger example
         compile_mode (str): mode passed to compile.
     """
     def __init__(self, exec_lines, want_lines=None, line_offset=0,
                  orig_lines=None, directives=None, partno=None):
+        """
+        Args:
+            exec_lines (List[str]): executable lines in this part
+            want_lines (List[str] | None): lines that the result of the execution should match
+            line_offset (int): line number relative to the start of the doctest
+            orig_lines (List[str] | None): the original text parsed into exec and want
+            directives (list | None): directives that this part will apply before being run
+            partno (int | None): identifies the part number in the larger example
+        """
         self.exec_lines = exec_lines
         self.want_lines = want_lines
         self.line_offset = line_offset
         self.orig_lines = orig_lines
-        self.compile_mode = 'exec'
         self._directives = directives
         self.partno = partno
+        self.compile_mode = 'exec'
 
     @property
     def n_lines(self):
+        """
+        Returns:
+            int
+        """
         return self.n_exec_lines + self.n_want_lines
 
     @property
     def n_exec_lines(self):
+        """
+        Returns:
+            int
+        """
         return len(self.exec_lines)
 
     @property
     def n_want_lines(self):
+        """
+        Returns:
+            int
+        """
         if self.want_lines:
             return len(self.want_lines)
         else:
@@ -61,11 +82,18 @@ def n_want_lines(self):
 
     @property
     def source(self):
+        """
+        Returns:
+            str
+        """
         return '\n'.join(self.exec_lines)
 
     def compilable_source(self):
         """
         Use this to build the string for compile. Takes care of a corner case.
+
+        Returns:
+            str
         """
         if self.compile_mode == 'single':
             return '\n'.join(self.exec_lines + [''])
@@ -77,6 +105,9 @@ def has_any_code(self):
         Heuristic to check if there is any runnable code in this doctest.  We
         currently just check that not every line is a comment, which helps the
         runner count a test as skipped if only lines with comments "ran".
+
+        Returns:
+            bool
         """
         slines = [line.strip() for line in self.exec_lines]
         return not all(
@@ -90,6 +121,9 @@ def directives(self):
         CommandLine:
             python -m xdoctest.parser DoctestPart.directives
 
+        Returns:
+            List[directive.Directive]
+
         Example:
             >>> self = DoctestPart(['# doctest: +SKIP'], None, 0)
             >>> print(', '.join(list(map(str, self.directives))))
@@ -101,6 +135,10 @@ def directives(self):
 
     @property
     def want(self):
+        """
+        Returns:
+            str | None
+        """
         # options = self._find_options(source, name, lineno + s1)
         # example = DoctestPart(source, None, None, lineno=lineno + s1,
         #                       indent=indent, options=options)
@@ -114,6 +152,10 @@ def want(self):
             return None
 
     def __nice__(self):
+        """
+        Returns:
+            str
+        """
         parts = []
         if self.line_offset is not None:
             parts.append('ln %s' % (self.line_offset))
@@ -156,6 +198,9 @@ def check(part, got_stdout, got_eval=constants.NOT_EVALED, runstate=None,
                 to match any trailing sequence of unmatched output and
                 got_stdout from this doctest part.
 
+        Returns:
+            None
+
         Raises:
             xdoctest.checker.GotWantException - If the "got" differs from this
                 parts want.
@@ -214,9 +259,12 @@ def format_part(self, linenos=True, want=True, startline=1, n_digits=None,
             want (bool): include the want value if it exists
             startline (int): offsets the line numbering
             n_digits (int): number of digits to use for line numbers
-            colored (bool): pygmentize the colde
+            colored (bool): pygmentize the code
             partnos (bool): if True, shows the part number in the string
-            prefix (bool): if False, exclude the doctest `>>> ` prefix
+            prefix (bool): if False, exclude the doctest ``>>> `` prefix
+
+        Returns:
+            str
 
         CommandLine:
             python -m xdoctest.doctest_part DoctestPart.format_part:0
diff --git a/xdoctest/doctest_part.pyi b/xdoctest/doctest_part.pyi
index e8ab8897..9735322a 100644
--- a/xdoctest/doctest_part.pyi
+++ b/xdoctest/doctest_part.pyi
@@ -1,57 +1,58 @@
-from _typeshed import Incomplete
+from typing import List
+from typing import Union
 from xdoctest import directive
 
 __devnotes__: str
 
 
 class DoctestPart:
-    exec_lines: Incomplete
-    want_lines: Incomplete
-    line_offset: Incomplete
-    orig_lines: Incomplete
+    exec_lines: List[str]
+    want_lines: Union[List[str], None]
+    line_offset: int
+    orig_lines: Union[List[str], None]
+    partno: Union[int, None]
     compile_mode: str
-    partno: Incomplete
 
     def __init__(self,
-                 exec_lines,
-                 want_lines: Incomplete | None = ...,
-                 line_offset: int = ...,
-                 orig_lines: Incomplete | None = ...,
-                 directives: Incomplete | None = ...,
-                 partno: Incomplete | None = ...) -> None:
+                 exec_lines: List[str],
+                 want_lines: Union[List[str], None] = None,
+                 line_offset: int = 0,
+                 orig_lines: Union[List[str], None] = None,
+                 directives: Union[list, None] = None,
+                 partno: Union[int, None] = None) -> None:
         ...
 
     @property
-    def n_lines(self):
+    def n_lines(self) -> int:
         ...
 
     @property
-    def n_exec_lines(self):
+    def n_exec_lines(self) -> int:
         ...
 
     @property
-    def n_want_lines(self):
+    def n_want_lines(self) -> int:
         ...
 
     @property
-    def source(self):
+    def source(self) -> str:
         ...
 
-    def compilable_source(self):
+    def compilable_source(self) -> str:
         ...
 
-    def has_any_code(self):
+    def has_any_code(self) -> bool:
         ...
 
     @property
-    def directives(self):
+    def directives(self) -> List[directive.Directive]:
         ...
 
     @property
-    def want(self):
+    def want(self) -> str | None:
         ...
 
-    def __nice__(self):
+    def __nice__(self) -> str:
         ...
 
     def check(part,
@@ -68,5 +69,5 @@ class DoctestPart:
                     n_digits: int = None,
                     colored: bool = False,
                     partnos: bool = False,
-                    prefix: bool = True):
+                    prefix: bool = True) -> str:
         ...
diff --git a/xdoctest/exceptions.py b/xdoctest/exceptions.py
index 1c05f763..f4e1f60f 100644
--- a/xdoctest/exceptions.py
+++ b/xdoctest/exceptions.py
@@ -16,6 +16,13 @@ class DoctestParseError(Exception):
     Exception raised when doctest code has an error.
     """
     def __init__(self, msg, string=None, info=None, orig_ex=None):
+        """
+        Args:
+            msg (str): error message
+            string (str): the string that failed
+            info (Any): extra information
+            orig_ex (Exception): The underlying exceptoin
+        """
         super(DoctestParseError, self).__init__(msg)
         self.msg = msg
         self.string = string
diff --git a/xdoctest/exceptions.pyi b/xdoctest/exceptions.pyi
index 8bc4b97d..10989cdb 100644
--- a/xdoctest/exceptions.pyi
+++ b/xdoctest/exceptions.pyi
@@ -1,4 +1,5 @@
-from _typeshed import Incomplete
+from typing import Any
+from typing import Any
 
 
 class MalformedDocstr(Exception):
@@ -6,16 +7,16 @@ class MalformedDocstr(Exception):
 
 
 class DoctestParseError(Exception):
-    msg: Incomplete
-    string: Incomplete
-    info: Incomplete
-    orig_ex: Incomplete
+    msg: str
+    string: str
+    info: Any
+    orig_ex: Exception
 
     def __init__(self,
-                 msg,
-                 string: Incomplete | None = ...,
-                 info: Incomplete | None = ...,
-                 orig_ex: Incomplete | None = ...) -> None:
+                 msg: str,
+                 string: str = None,
+                 info: Any = None,
+                 orig_ex: Exception = None) -> None:
         ...
 
 
diff --git a/xdoctest/global_state.py b/xdoctest/global_state.py
index e64a733b..4e32747c 100644
--- a/xdoctest/global_state.py
+++ b/xdoctest/global_state.py
@@ -7,6 +7,13 @@
 
 
 def _boolean_environ(key):
+    """
+    Args:
+        key (str)
+
+    Returns:
+        bool
+    """
     value = os.environ.get(key, '').lower()
     TRUTHY_ENVIRONS = {'true', 'on', 'yes', '1'}
     return value in TRUTHY_ENVIRONS
diff --git a/xdoctest/parser.py b/xdoctest/parser.py
index d0f336a4..2f62824b 100644
--- a/xdoctest/parser.py
+++ b/xdoctest/parser.py
@@ -88,6 +88,12 @@ class DoctestParser(object):
     """
 
     def __init__(self, simulate_repl=False):
+        """
+        Args:
+            simulate_repl (bool): if True each line will be treated as its
+                own doctest. This more closely mimics the original doctest
+                module.  Defaults to False.
+        """
         self.simulate_repl = simulate_repl
 
     def parse(self, string, info=None):
@@ -96,11 +102,12 @@ def parse(self, string, info=None):
 
         Args:
             string (str): string representing the doctest
-            info (dict): info about where the string came from in case of an
+            info (dict | None): info about where the string came from in case of an
                 error
 
         Returns:
-            list : a list of `DoctestPart` objects
+            List[xdoctest.doctest_part.DoctestPart]:
+                a list of `DoctestPart` objects
 
         CommandLine:
             python -m xdoctest.parser DoctestParser.parse
diff --git a/xdoctest/parser.pyi b/xdoctest/parser.pyi
index cb6077f7..e326f4d0 100644
--- a/xdoctest/parser.pyi
+++ b/xdoctest/parser.pyi
@@ -1,3 +1,7 @@
+from typing import Union
+from typing import List
+import xdoctest
+import xdoctest.doctest_part
 from _typeshed import Incomplete
 
 INDENT_RE: Incomplete
@@ -6,10 +10,14 @@ PY2: Incomplete
 
 
 class DoctestParser:
-    simulate_repl: Incomplete
+    simulate_repl: bool
 
-    def __init__(self, simulate_repl: bool = ...) -> None:
+    def __init__(self, simulate_repl: bool = False) -> None:
         ...
 
-    def parse(self, string: str, info: dict = None) -> list:
+    def parse(
+        self,
+        string: str,
+        info: Union[dict,
+                    None] = None) -> List[xdoctest.doctest_part.DoctestPart]:
         ...
diff --git a/xdoctest/plugin.py b/xdoctest/plugin.py
index 006d5f11..319f097e 100644
--- a/xdoctest/plugin.py
+++ b/xdoctest/plugin.py
@@ -167,6 +167,12 @@ def _is_xdoctest(config, path, parent):
 class ReprFailXDoctest(code.TerminalRepr):
 
     def __init__(self, reprlocation, lines):
+        """
+        Args:
+            reprlocation (Any):
+                _pytest._code.code.ReprFileLocation where the error happened
+            lines (List[str]): text of the error
+        """
         self.reprlocation = reprlocation
         self.lines = lines
 
@@ -178,6 +184,12 @@ def toterminal(self, tw):
 
 class XDoctestItem(pytest.Item):
     def __init__(self, name, parent, example=None):
+        """
+        Args:
+            name (str):
+            parent (Any | None):
+            example (xdoctest.doctest_example.DocTest):
+        """
         super(XDoctestItem, self).__init__(name, parent)
         self.cls = XDoctestItem
         self.example = example
@@ -201,6 +213,13 @@ def runtest(self):
             pytest.skip('doctest is empty or all parts were skipped')
 
     def repr_failure(self, excinfo):
+        """
+        # Args:
+        #     excinfo (_pytest._code.code.ExceptionInfo):
+
+        # Returns:
+        #     ReprFailXDoctest | str | _pytest._code.code.TerminalRepr:
+        """
         example = self.example
         if example.exc_info is not None:
             lineno = example.failed_lineno()
@@ -214,6 +233,10 @@ def repr_failure(self, excinfo):
             return super(XDoctestItem, self).repr_failure(excinfo)
 
     def reportinfo(self):
+        """
+        Returns:
+            Tuple[str, int, str]
+        """
         return self.fspath, self.example.lineno, "[xdoctest] %s" % self.name
 
 
@@ -239,6 +262,10 @@ class XDoctestTextfile(_XDoctestBase):
     obj = None
 
     def collect(self):
+        """
+        Yields:
+            XDoctestItem
+        """
         from xdoctest import core
         encoding = self.config.getini("xdoctest_encoding")
         text = self.fspath.read_text(encoding)
@@ -296,6 +323,12 @@ def collect(self):
 def _setup_fixtures(xdoctest_item):
     """
     Used by XDoctestTextfile and XDoctestItem to setup fixture information.
+
+    Args:
+        xdoctest_item (XDoctestItem):
+
+    Returns:
+        fixtures.FixtureRequest
     """
     def func():
         pass
@@ -321,5 +354,8 @@ def func():
 def xdoctest_namespace():
     """
     Inject names into the xdoctest namespace.
+
+    Returns:
+        Dict
     """
     return dict()
diff --git a/xdoctest/plugin.pyi b/xdoctest/plugin.pyi
index 4fc6c301..4c5a89a8 100644
--- a/xdoctest/plugin.pyi
+++ b/xdoctest/plugin.pyi
@@ -1,3 +1,9 @@
+from typing import Any
+from typing import List
+from typing import Union
+import xdoctest
+from typing import Tuple
+from typing import Dict
 import pytest
 from _pytest._code import code
 from _typeshed import Incomplete
@@ -18,10 +24,10 @@ def pytest_collect_file(path, parent):
 
 
 class ReprFailXDoctest(code.TerminalRepr):
-    reprlocation: Incomplete
-    lines: Incomplete
+    reprlocation: Any
+    lines: List[str]
 
-    def __init__(self, reprlocation, lines) -> None:
+    def __init__(self, reprlocation: Any, lines: List[str]) -> None:
         ...
 
     def toterminal(self, tw) -> None:
@@ -30,11 +36,14 @@ class ReprFailXDoctest(code.TerminalRepr):
 
 class XDoctestItem(pytest.Item):
     cls: Incomplete
-    example: Incomplete
+    example: xdoctest.doctest_example.DocTest
     obj: Incomplete
     fixture_request: Incomplete
 
-    def __init__(self, name, parent, example: Incomplete | None = ...) -> None:
+    def __init__(self,
+                 name: str,
+                 parent: Union[Any, None],
+                 example: xdoctest.doctest_example.DocTest = None) -> None:
         ...
 
     def setup(self) -> None:
@@ -46,7 +55,7 @@ class XDoctestItem(pytest.Item):
     def repr_failure(self, excinfo):
         ...
 
-    def reportinfo(self):
+    def reportinfo(self) -> Tuple[str, int, str]:
         ...
 
 
@@ -57,7 +66,7 @@ class _XDoctestBase(pytest.Module):
 class XDoctestTextfile(_XDoctestBase):
     obj: Incomplete
 
-    def collect(self) -> Generator[Any, None, None]:
+    def collect(self) -> Generator[XDoctestItem, None, None]:
         ...
 
 
@@ -67,5 +76,5 @@ class XDoctestModule(_XDoctestBase):
         ...
 
 
-def xdoctest_namespace():
+def xdoctest_namespace() -> Dict:
     ...
diff --git a/xdoctest/runner.py b/xdoctest/runner.py
index 2c39fe32..a716bfed 100644
--- a/xdoctest/runner.py
+++ b/xdoctest/runner.py
@@ -62,6 +62,11 @@
 
 
 def log(msg, verbose):
+    """
+    Args:
+        msg (str):
+        verbose (int):
+    """
     if verbose > 0:
         print(msg)
 
@@ -120,13 +125,13 @@ def doctest_module(module_identifier=None, command=None, argv=None, exclude=[],
             'list' - list the tests in a module
             'dump' - dumps tests to stdout
 
-        argv (List[str], default=None):
+        argv (List[str] | None):
             if specified, command line flags that might influence beharior.
             if None uses sys.argv.
             SeeAlso :func:_update_argparse_cli
             SeeAlso :func:doctest_example.DoctestConfig._update_argparse_cli
 
-        verbose (int, default=None):
+        verbose (int | None):
             Verbosity level.
             0 - disables all text
             1 - minimal printing
@@ -138,13 +143,13 @@ def doctest_module(module_identifier=None, command=None, argv=None, exclude=[],
         config (Dict[str, object]):
             modifies each examples configuration
 
-        durations (int, default=None): if specified report top N slowest tests
+        durations (int | None): if specified report top N slowest tests
 
         analysis (str): determines if doctests are found using static or
             dynamic analysis.
 
     Returns:
-        Dict: run_summary
+        Dict[str, Any]: run_summary
 
     Example:
         >>> modname = 'xdoctest.dynamic_analysis'
diff --git a/xdoctest/runner.pyi b/xdoctest/runner.pyi
index fdac99fa..44ea3ac3 100644
--- a/xdoctest/runner.pyi
+++ b/xdoctest/runner.pyi
@@ -3,9 +3,10 @@ from typing import Union
 from types import ModuleType
 from typing import List
 from typing import Dict
+from typing import Any
 
 
-def log(msg, verbose) -> None:
+def log(msg: str, verbose: int) -> None:
     ...
 
 
@@ -15,11 +16,11 @@ def doctest_callable(func: Callable) -> None:
 
 def doctest_module(module_identifier: Union[str, ModuleType, None] = None,
                    command: str = None,
-                   argv: List[str] = None,
+                   argv: Union[List[str], None] = None,
                    exclude: List[str] = ...,
                    style: str = ...,
-                   verbose: int = None,
+                   verbose: Union[int, None] = None,
                    config: Dict[str, object] = None,
-                   durations: int = None,
-                   analysis: str = 'auto') -> Dict:
+                   durations: Union[int, None] = None,
+                   analysis: str = 'auto') -> Dict[str, Any]:
     ...
diff --git a/xdoctest/static_analysis.py b/xdoctest/static_analysis.py
index 11193008..fc03459a 100644
--- a/xdoctest/static_analysis.py
+++ b/xdoctest/static_analysis.py
@@ -103,6 +103,9 @@ def parse(cls, source):
         main entry point
 
         executes parsing algorithm and populates self.calldefs
+
+        Args:
+            source (str):
         """
         self = cls(source)
         pt = self.syntax_tree()
@@ -114,6 +117,10 @@ def parse(cls, source):
         return self
 
     def __init__(self, source=None):
+        """
+        Args:
+            source (None | str):
+        """
         super(TopLevelVisitor, self).__init__()
         self.calldefs = OrderedDict()
         self.source = source
@@ -127,14 +134,24 @@ def __init__(self, source=None):
         self.assignments = []
 
     def syntax_tree(self):
-        """ creates the abstract syntax tree """
+        """
+        creates the abstract syntax tree
+
+        Returns:
+            ast.Module:
+        """
         self.sourcelines = self.source.splitlines()
         source_utf8  = self.source.encode('utf8')
         pt = ast.parse(source_utf8)
         return pt
 
     def process_finished(self, node):
-        """ process (get ending lineno) for everything marked as finished """
+        """
+        process (get ending lineno) for everything marked as finished
+
+        Args:
+            node (ast.AST):
+        """
         if self._finish_queue:
             if isinstance(node, int):
                 lineno_end = node
@@ -145,10 +162,18 @@ def process_finished(self, node):
                 calldef.lineno_end = lineno_end
 
     def visit(self, node):
+        """
+        Args:
+            node (ast.AST):
+        """
         self.process_finished(node)
         super(TopLevelVisitor, self).visit(node)
 
     def visit_FunctionDef(self, node):
+        """
+        Args:
+            node (ast.FunctionDef):
+        """
         if self._current_classname is None:
             callname = node.name
         else:
@@ -180,6 +205,10 @@ def visit_FunctionDef(self, node):
         self._finish_queue.append(calldef)
 
     def visit_ClassDef(self, node):
+        """
+        Args:
+            node (ast.ClassDef):
+        """
         if self._current_classname is None:
             callname = node.name
             self._current_classname = callname
@@ -194,6 +223,10 @@ def visit_ClassDef(self, node):
             self._finish_queue.append(calldef)
 
     def visit_Module(self, node):
+        """
+        Args:
+            node (ast.Module):
+        """
         # get the module level docstr
         docstr, doclineno, doclineno_end = self._get_docstring(node)
         if docstr:
@@ -208,6 +241,10 @@ def visit_Module(self, node):
         # self._finish_queue.append(calldef)
 
     def visit_Assign(self, node):
+        """
+        Args:
+            node (ast.Assign):
+        """
         # print('VISIT FunctionDef node = %r' % (node,))
         # print('VISIT FunctionDef node = %r' % (node.__dict__,))
         if self._current_classname is None:
@@ -220,6 +257,10 @@ def visit_Assign(self, node):
         self.generic_visit(node)
 
     def visit_If(self, node):
+        """
+        Args:
+            node (ast.If):
+        """
         if isinstance(node.test, ast.Compare):  # pragma: nobranch
             try:
                 if all([
@@ -253,6 +294,12 @@ def _docnode_line_workaround(self, docnode):
         """
         Find the start and ending line numbers of a docstring
 
+        Args:
+            docnode (ast.AST):
+
+        Returns:
+            Tuple[int, int]
+
         CommandLine:
             xdoctest -m xdoctest.static_analysis TopLevelVisitor._docnode_line_workaround
 
@@ -957,6 +1004,9 @@ def extract_comments(source):
     Returns the text in each comment in a block of python code.
     Uses tokenize to account for quotations.
 
+    Args:
+        source (str):
+
     CommandLine:
         python -m xdoctest.static_analysis extract_comments
 
@@ -993,6 +1043,14 @@ def _readline():
 def six_axt_parse(source_block, filename='<source_block>', compatible=True):
     """
     Python 2/3 compatible replacement for ast.parse(source_block, filename='<source_block>')
+
+    Args:
+        source (str):
+        filename (str):
+        compatible (bool):
+
+    Returns:
+        ast.Module | types.CodeType
     """
     # Note Python2.7 does not accept unicode variable names so this
     # will fail (in 2.7) if source contains a unicode varname.
diff --git a/xdoctest/static_analysis.pyi b/xdoctest/static_analysis.pyi
index fad3e109..c4903ddc 100644
--- a/xdoctest/static_analysis.pyi
+++ b/xdoctest/static_analysis.pyi
@@ -1,5 +1,8 @@
+from typing import Union
+import ast
 from typing import Dict
 from typing import List
+import types
 import ast
 from _typeshed import Incomplete
 from collections.abc import Generator
@@ -11,11 +14,11 @@ HAS_UPDATED_LINENOS: Incomplete
 
 
 class CallDefNode:
-    callname: Incomplete
+    callname: str
+    doclineno: int
+    doclineno_end: int
     lineno: Incomplete
     docstr: Incomplete
-    doclineno: Incomplete
-    doclineno_end: Incomplete
     lineno_end: Incomplete
     args: Incomplete
 
@@ -32,39 +35,39 @@ class CallDefNode:
 class TopLevelVisitor(ast.NodeVisitor):
 
     @classmethod
-    def parse(cls, source):
+    def parse(cls, source: str):
         ...
 
     calldefs: Incomplete
-    source: Incomplete
+    source: Union[None, str]
     sourcelines: Incomplete
     assignments: Incomplete
 
-    def __init__(self, source: Incomplete | None = ...) -> None:
+    def __init__(self, source: Union[None, str] = None) -> None:
         ...
 
-    def syntax_tree(self):
+    def syntax_tree(self) -> ast.Module:
         ...
 
-    def process_finished(self, node) -> None:
+    def process_finished(self, node: ast.AST) -> None:
         ...
 
-    def visit(self, node) -> None:
+    def visit(self, node: ast.AST) -> None:
         ...
 
-    def visit_FunctionDef(self, node) -> None:
+    def visit_FunctionDef(self, node: ast.FunctionDef) -> None:
         ...
 
-    def visit_ClassDef(self, node) -> None:
+    def visit_ClassDef(self, node: ast.ClassDef) -> None:
         ...
 
-    def visit_Module(self, node) -> None:
+    def visit_Module(self, node: ast.Module) -> None:
         ...
 
-    def visit_Assign(self, node) -> None:
+    def visit_Assign(self, node: ast.Assign) -> None:
         ...
 
-    def visit_If(self, node) -> None:
+    def visit_If(self, node: ast.If) -> None:
         ...
 
 
@@ -98,9 +101,11 @@ def is_balanced_statement(lines: List[str],
     ...
 
 
-def extract_comments(source) -> Generator[Any, None, Any]:
+def extract_comments(source: str) -> Generator[Any, None, Any]:
     ...
 
 
-def six_axt_parse(source_block, filename: str = ..., compatible: bool = ...):
+def six_axt_parse(source_block,
+                  filename: str = '<source_block>',
+                  compatible: bool = True) -> ast.Module | types.CodeType:
     ...
diff --git a/xdoctest/utils/util_str.py b/xdoctest/utils/util_str.py
index 99b46f01..77140bd9 100644
--- a/xdoctest/utils/util_str.py
+++ b/xdoctest/utils/util_str.py
@@ -22,6 +22,12 @@ def strip_ansi(text):
     r"""
     Removes all ansi directives from the string.
 
+    Args:
+        text (str):
+
+    Returns:
+        str
+
     References:
         http://stackoverflow.com/questions/14693701/remove-ansi
         https://stackoverflow.com/questions/13506033/filtering-out-ansi-escape-sequences
@@ -51,7 +57,7 @@ def color_text(text, color):
             standout, darkteal, darkgray, overline, purple, green, teal, fuscia
 
     Returns:
-        str: text : colorized text.
+        str: colorized text.
             If pygments is not installed plain text is returned.
 
     Example:
@@ -118,6 +124,12 @@ def ensure_unicode(text):
     """
     Casts bytes into utf8 (mostly for python2 compatibility)
 
+    Args:
+        text (str):
+
+    Returns:
+        str
+
     References:
         http://stackoverflow.com/questions/12561063/python-extract-data-from-file
 
@@ -233,6 +245,14 @@ def add_line_numbers(source, start=1, n_digits=None):
     """
     Prefixes code with line numbers
 
+    Args:
+        source (str | List[str]):
+        start (int):
+        n_digits (int | None):
+
+    Returns:
+        List[str] | str
+
     Example:
         >>> print(chr(10).join(add_line_numbers(['a', 'b', 'c'])))
         1 a
diff --git a/xdoctest/utils/util_str.pyi b/xdoctest/utils/util_str.pyi
index df2939e5..d7b459af 100644
--- a/xdoctest/utils/util_str.pyi
+++ b/xdoctest/utils/util_str.pyi
@@ -1,9 +1,11 @@
+from typing import Union
+from typing import List
 from _typeshed import Incomplete
 
 NO_COLOR: Incomplete
 
 
-def strip_ansi(text):
+def strip_ansi(text: str) -> str:
     ...
 
 
@@ -11,7 +13,7 @@ def color_text(text: str, color: str) -> str:
     ...
 
 
-def ensure_unicode(text):
+def ensure_unicode(text: str) -> str:
     ...
 
 
@@ -23,9 +25,9 @@ def highlight_code(text: str, lexer_name: str = 'python', **kwargs) -> str:
     ...
 
 
-def add_line_numbers(source,
-                     start: int = ...,
-                     n_digits: Incomplete | None = ...):
+def add_line_numbers(source: Union[str, List[str]],
+                     start: int = 1,
+                     n_digits: Union[int, None] = None) -> List[str] | str:
     ...
 
 
diff --git a/xdoctest/utils/util_stream.pyi b/xdoctest/utils/util_stream.pyi
index 3aafbaf1..fa5a840b 100644
--- a/xdoctest/utils/util_stream.pyi
+++ b/xdoctest/utils/util_stream.pyi
@@ -1,9 +1,10 @@
 import io
+import io
 from _typeshed import Incomplete
 
 
 class TeeStringIO(io.StringIO):
-    redirect: Incomplete
+    redirect: io.IOBase
     buffer: Incomplete
 
     def __init__(self, redirect: Incomplete | None = ...) -> None:

From 43f97904f0d5d3e8a06fce92f3c29945c55fd48e Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 22:01:25 -0400
Subject: [PATCH 27/38] pypy fix

---
 dev/port_ubelt_utils.py       | 28 +++++++++++++---------------
 xdoctest/utils/util_import.py | 32 +++++++++++++++++++-------------
 2 files changed, 32 insertions(+), 28 deletions(-)

diff --git a/dev/port_ubelt_utils.py b/dev/port_ubelt_utils.py
index 451ddaa5..b8cd6ac4 100644
--- a/dev/port_ubelt_utils.py
+++ b/dev/port_ubelt_utils.py
@@ -5,23 +5,21 @@
 
 def _autogen_xdoctest_utils():
     import ubelt as ub
-
-    # Uses netharn closer until it is ported to a standalone module
-    from liberator import closer
-    closer = closer.Closer()
+    import liberator
+    lib = liberator.Liberator()
 
     from ubelt import util_import
-    closer.add_dynamic(util_import.split_modpath)
-    closer.add_dynamic(util_import.modpath_to_modname)
-    closer.add_dynamic(util_import.modname_to_modpath)
-    closer.add_dynamic(util_import.import_module_from_name)
-    closer.add_dynamic(util_import.import_module_from_path)
-    closer.add_dynamic(util_import._pkgutil_modname_to_modpath)
-    closer.add_dynamic(util_import._importlib_import_modpath)
-    closer.add_dynamic(util_import.is_modname_importable)
-
-    closer.expand(['ubelt'])
-    text = closer.current_sourcecode()
+    lib.add_dynamic(util_import.split_modpath)
+    lib.add_dynamic(util_import.modpath_to_modname)
+    lib.add_dynamic(util_import.modname_to_modpath)
+    lib.add_dynamic(util_import.import_module_from_name)
+    lib.add_dynamic(util_import.import_module_from_path)
+    lib.add_dynamic(util_import._pkgutil_modname_to_modpath)
+    lib.add_dynamic(util_import._importlib_import_modpath)
+    lib.add_dynamic(util_import.is_modname_importable)
+
+    lib.expand(['ubelt'])
+    text = lib.current_sourcecode()
     print(text)
 
     import redbaron
diff --git a/xdoctest/utils/util_import.py b/xdoctest/utils/util_import.py
index 63b2367f..18f309f7 100644
--- a/xdoctest/utils/util_import.py
+++ b/xdoctest/utils/util_import.py
@@ -199,12 +199,22 @@ def import_module_from_path(modpath, index=-1):
     """
     Imports a module via its path
 
+    This works by modifying ``sys.path``, importing the module name, and then
+    attempting to undo the change to sys.path. This function may produce
+    unexpected results in the case where the imported module itself itself
+    modifies ``sys.path`` or if there is another conflicting module with the
+    same name.
+
     Args:
-        modpath (PathLike): path to the module on disk or within a zipfile.
-        index (int): location at which we modify PYTHONPATH if necessary.
-            If your module name does not conflict, the safest value is -1,
-            However, if there is a conflict, then use an index of 0.
-            The default may change to 0 in the future.
+        modpath (str | PathLike):
+            Path to the module on disk or within a zipfile. Paths within a
+            zipfile can be given by ``<path-to>.zip/<path-inside-zip>.py``.
+
+        index (int):
+            Location at which we modify PYTHONPATH if necessary.  If your
+            module name does not conflict, the safest value is -1, However, if
+            there is a conflict, then use an index of 0.  The default may
+            change to 0 in the future.
 
     Returns:
         ModuleType: the imported module
@@ -256,32 +266,28 @@ def import_module_from_path(modpath, index=-1):
         >>> # Test importing a module from within a zipfile
         >>> import zipfile
         >>> from xdoctest import utils
-        >>> from os.path import join, expanduser
+        >>> from os.path import join, expanduser, normpath
         >>> dpath = expanduser('~/.cache/xdoctest')
         >>> dpath = utils.ensuredir(dpath)
+        >>> #dpath = utils.TempDir().ensure()
         >>> # Write to an external module named bar
         >>> external_modpath = join(dpath, 'bar.py')
         >>> # For pypy support we have to write this using with
         >>> with open(external_modpath, 'w') as file:
         >>>     file.write('testvar = 1')
-        >>> assert open(external_modpath, 'r').read() == 'testvar = 1'
         >>> internal = 'folder/bar.py'
         >>> # Move the external bar module into a zipfile
         >>> zippath = join(dpath, 'myzip.zip')
         >>> with zipfile.ZipFile(zippath, 'w') as myzip:
         >>>     myzip.write(external_modpath, internal)
-        >>> assert exists(zippath)
         >>> # Import the bar module from within the zipfile
         >>> modpath = zippath + ':' + internal
         >>> modpath = zippath + os.path.sep + internal
         >>> module = import_module_from_path(modpath)
-        >>> assert module.__name__ == os.path.normpath('folder/bar')
-        >>> print('module = {!r}'.format(module))
-        >>> print('module.__file__ = {!r}'.format(module.__file__))
-        >>> print(dir(module))
+        >>> assert normpath(module.__name__) == normpath('folder/bar')
         >>> assert module.testvar == 1
 
-    Doctest:
+    Example:
         >>> # xdoctest: +REQUIRES(module:pytest)
         >>> import pytest
         >>> with pytest.raises(IOError):

From 3a55f510bcd5db0002a06283a7d9cf5fd09f05f5 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sat, 9 Jul 2022 22:43:44 -0400
Subject: [PATCH 28/38] Disable import test on pypi

---
 xdoctest/utils/util_import.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/xdoctest/utils/util_import.py b/xdoctest/utils/util_import.py
index 18f309f7..929f3765 100644
--- a/xdoctest/utils/util_import.py
+++ b/xdoctest/utils/util_import.py
@@ -263,6 +263,7 @@ def import_module_from_path(modpath, index=-1):
         >>> assert module is xdoctest
 
     Example:
+        >>> # xdoctest: +REQUIRES(CPYTHON)
         >>> # Test importing a module from within a zipfile
         >>> import zipfile
         >>> from xdoctest import utils

From 5abca78c174773eff2273aeacc519c00f756aa2a Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 12:13:40 -0400
Subject: [PATCH 29/38] update readme

---
 README.rst | 80 ++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 65 insertions(+), 15 deletions(-)

diff --git a/README.rst b/README.rst
index 26b2bc13..4d6fda7c 100644
--- a/README.rst
+++ b/README.rst
@@ -163,8 +163,12 @@ Using the native interface.
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 In addition to the ``pytest`` plugin, xdoctest has a native doctest runner.
-This interface is run programmatically using ``xdoctest.doctest_module(path)``,
-which can be placed in the ``__main__`` section of any module as such:
+You can use the ``xdoctest`` command line tool that is installed with the
+package and point it a module directory or a particular file.
+
+You can also make it such that invoking your module as ``__main__`` invokes the
+xdoctest native runner using the using the ``xdoctest.doctest_module(path)``
+method, which can be placed in the ``__main__`` section of any module as such:
 
 .. code:: python
 
@@ -173,7 +177,15 @@ which can be placed in the ``__main__`` section of any module as such:
         xdoctest.doctest_module(__file__)
 
 This sets up the ability to invoke the ``xdoctest`` command line
-interface. ``python -m <modname> <command>``
+interface. ``python -m <modname> <command>``. 
+
+However, it is typically prefered to just use the ``xdoctest`` executable and
+pass it the path to your file, or the name of an installed module. In this case
+it is invoked like ``xdoctest -m <modname> <command>``.
+
+Using either of these methods you can natively invoke xdoctest on a module or
+package, which exposes the command line interface. Both of these expose the
+command line interface, allowing you to pass a command to xdoctest.
 
 -  If ``<command>`` is ``all``, then each enabled doctest in the module
    is executed: ``python -m <modname> all``
@@ -210,20 +222,58 @@ code:
         """
         return a + 1
 
-    if __name__ == '__main__':
-        import xdoctest 
-        xdoctest.doctest_module(__file__)
-
 You could 
 
-* Use the command ``python -m mymod list`` to list the names of all functions with doctests
-* Use the command ``python -m mymod all`` to run all functions with doctests
-* Use the command ``python -m mymod func1`` to run only func1's doctest
-* Use the command ``python -m mymod func2`` to run only func2's doctest
-
-Lastly, by running the command ``xdoctest.doctest_module(<pkgname>)``,
-``xdoctest`` will recursively find and execute all doctests within the
-modules belonging to the package.
+* Use the command ``xdoctest -m mymod list`` to list the names of all functions with doctests
+* Use the command ``xdoctest -m mymod all`` to run all functions with doctests
+* Use the command ``xdoctest -m mymod func1`` to run only func1's doctest
+* Use the command ``xdoctest -m mymod func2`` to run only func2's doctest
+
+
+Passing ``--help`` to either way of invoking the native runner will result in
+something similar to the following that outlines what other options are
+available:
+
+.. code:: 
+
+    usage: xdoctest [-h] [--version] [-m MODNAME] [-c COMMAND] [--style {auto,google,freeform}] [--analysis {auto,static,dynamic}] [--durations DURATIONS] [--time]
+                    [--colored COLORED] [--nocolor] [--offset] [--report {none,cdiff,ndiff,udiff,only_first_failure}] [--options OPTIONS] [--global-exec GLOBAL_EXEC]
+                    [--verbose VERBOSE] [--quiet] [--silent]
+                    [arg ...]
+
+    Xdoctest 1.0.1 - on Python - 3.9.9 (main, Jun 10 2022, 17:45:11) 
+    [GCC 11.2.0] - discover and run doctests within a python package
+
+    positional arguments:
+      arg                   Ignored if optional arguments are specified, otherwise: Defaults --modname to arg.pop(0). Defaults --command to arg.pop(0). (default: None)
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      --version             Display version info and quit (default: False)
+      -m MODNAME, --modname MODNAME
+                            Module name or path. If specified positional modules are ignored (default: None)
+      -c COMMAND, --command COMMAND
+                            A doctest name or a command (list|all|<callname>). Defaults to all (default: None)
+      --style {auto,google,freeform}
+                            Choose the style of doctests that will be parsed (default: auto)
+      --analysis {auto,static,dynamic}
+                            How doctests are collected (default: auto)
+      --durations DURATIONS
+                            Specify execution times for slowest N tests.N=0 will show times for all tests (default: None)
+      --time                Same as if durations=0 (default: False)
+      --colored COLORED     Enable or disable ANSI coloration in stdout (default: True)
+      --nocolor             Disable ANSI coloration in stdout
+      --offset              If True formatted source linenumbers will agree with their location in the source file. Otherwise they will be relative to the doctest itself. (default:
+                            False)
+      --report {none,cdiff,ndiff,udiff,only_first_failure}
+                            Choose another output format for diffs on xdoctest failure (default: udiff)
+      --options OPTIONS     Default directive flags for doctests (default: None)
+      --global-exec GLOBAL_EXEC
+                            Custom Python code to execute before every test (default: None)
+      --verbose VERBOSE     Verbosity level. 0 is silent, 1 prints out test names, 2 additionally prints test stdout, 3 additionally prints test source (default: 3)
+      --quiet               sets verbosity to 1
+      --silent              sets verbosity to 0
+       
 
 Zero-args runner
 ^^^^^^^^^^^^^^^^

From 9083361b6e109b4cb4b6f3c4655e1bd47603ee03 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 13:35:36 -0400
Subject: [PATCH 30/38] prepare for moving module to src directory

---
 .github/workflows/tests.yml  |  10 +-
 dev/_travis_CI_old.yml       | 281 -----------------------------------
 dev/make_strict_req.sh       |  14 --
 pyproject.toml               |  39 ++++-
 setup.py                     | 103 ++++++-------
 xdoctest/__init__.py         |   2 +-
 xdoctest/__main__.py         |   2 +-
 xdoctest/doctest_example.py  |   7 +-
 xdoctest/dynamic_analysis.py |   1 +
 xdoctest/runner.py           |   2 +-
 xdoctest/static_analysis.py  |   2 +-
 11 files changed, 96 insertions(+), 367 deletions(-)
 delete mode 100644 dev/_travis_CI_old.yml
 delete mode 100644 dev/make_strict_req.sh

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 8b91d9b6..3de69723 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -27,12 +27,12 @@ jobs:
     - name: Lint with flake8
       run: |-
         # stop the build if there are Python syntax errors or undefined names
-        flake8 ./xdoctest --count --select=E9,F63,F7,F82 --show-source --statistics
+        flake8 ./src/xdoctest --count --select=E9,F63,F7,F82 --show-source --statistics
     - name: Typecheck with mypy
       run: |-
         python -m pip install mypy
-        mypy --install-types --non-interactive ./xdoctest
-        mypy ./xdoctest
+        mypy --install-types --non-interactive ./src/xdoctest
+        mypy ./src/xdoctest
   build_and_test_sdist:
     name: Test sdist Python 3.8
     runs-on: ubuntu-latest
@@ -100,7 +100,6 @@ jobs:
         - macOS-latest
         python-version:
         - '2.7'
-        #- '3.4'
         - '3.5'
         - '3.6'
         - '3.7'
@@ -317,6 +316,7 @@ jobs:
         echo "GPG_KEYID = '$GPG_KEYID'"
         DO_GPG=True GPG_KEYID=$GPG_KEYID TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL} TWINE_PASSWORD=$TWINE_PASSWORD TWINE_USERNAME=$TWINE_USERNAME GPG_EXECUTABLE=$GPG_EXECUTABLE DO_UPLOAD=True DO_TAG=False ./publish.sh
 
+
 ###
 # Unfortunately we cant (yet) use the yaml docstring trick here
 # https://github.community/t/allow-unused-keys-in-workflow-yaml-files/172120
@@ -334,4 +334,4 @@ jobs:
 #        --secret=EROTEMIC_TWINE_USERNAME=$EROTEMIC_TWINE_USERNAME \
 #        --secret=EROTEMIC_CI_SECRET=$EROTEMIC_CI_SECRET \
 #        --secret=EROTEMIC_TEST_TWINE_USERNAME=$EROTEMIC_TEST_TWINE_USERNAME \
-#        --secret=EROTEMIC_TEST_TWINE_PASSWORD=$EROTEMIC_TEST_TWINE_PASSWORD
+#        --secret=EROTEMIC_TEST_TWINE_PASSWORD=$EROTEMIC_TEST_TWINE_PASSWORD
\ No newline at end of file
diff --git a/dev/_travis_CI_old.yml b/dev/_travis_CI_old.yml
deleted file mode 100644
index 0b18baa4..00000000
--- a/dev/_travis_CI_old.yml
+++ /dev/null
@@ -1,281 +0,0 @@
-# yaml merge-expand .travis.ymls _expandyml && cat _expandyml
-# 
-env:
-    global:
-        - secure: "P+9EGVR9Z0PSdkuo/xYtGxJRjfjhHLqhCz04bVkbOo/Tpcaqa2sHBYAlWE8jm+m0PODnQ2Mao/xaNqkbmt+bTwmBQ4wPE+OW4+Po8qdZoOz7mv53KN8AUeSUOmifiZsaJSDAQwrnP8KbCRor1zB+0rn6eok3gc2ZWnFs0+t1jfATjlnZfpqfQxxWWSdVO6j24d1+CUiZaCU16q4OiwSePmipKvBySyLEwxTgNuPyESMyGG6UwbBpzSWH2/4iMNUiaEcoR1LaHglhHOa98ZMnwpbU5O3Jj7WSI4UlJqLsK0GnZpNEsXC70mvu4Sq8vqFpvY0zln+8yl9qbdeTU2eLd0PRzpcLhhBdhIBwG2dX8BkP2U6I0wWW8xoME9krtgFmV5f6y3WMsv/WvqEUbP0LD31KLil49IMqh2XcMWjLwgQF9kJ0ANcTN4rIoXvPMWKjfWABb2B7Tf+UxPaN1mAxhr2cv2x2egwAzrQsr9qT0lPEyOz3j4AnN8RDweEcPVT0GpZRjVd6fJ4J/ey89ntF1wYsTGG4kl9861iA+eZyvZM5cIBo69xEJoq9YW7sW5vW3xbxVFViDRM8chM1UXeIvBwl3a3xUYIjJyIwNBKbXZpjeEQnpalvmsZZfQKIAqgkSN1+ylvycDizQm1yAjo9c12S5sj9pS+PZQBVJkBEzC8="
-        - secure: "Art3JeQQ/T5gKT6m4S8xylwweLsXYX3qaVG5ZumsQkWzWrvJwXCeq4o+koa19Z1t9Gszo+WTYifVn95utX9+AUhgcbwUbwvpCACgiBTVlMDdVa9km8egPZ1TvFuOgeIR6xj/hz+p+RtCTlZ1sMgeXV9yTgnlLnFiKecY36ZN2hvWD+cz7idocFfhq+jCfQiaxReRrxO7UwCYxbldduZ1b90DfST+JnJTOW8cf27ChlfguNi6l/k2/guivABH6euBuDojmoKxCzQOJxjrhHw07yaRDLxi0ZTe0LAjOuehLvMmoP+iVKpg2OepMfm+pIPzR4CJeChF0xD6O93uc7zgltQx8QBmwg4Z30y21xzIhtYf6Yw1PTSsWMGTCk9nI7MkdB8Ao4Y2t4MPkN9IlNvQ6fsa5d8fCMf8j2fYPJYv2AgqXE+yyMHhhOUXmQhYW+lDAaNn6NQ7Xnk064UR+Vqdrmg1pUac2tx+wSDvNk96TU1Gdvia8gbKP5UpTFNR90Txxxmdt4pES/jB82zpR0OIC+kpP6p7BiqY/7P/6HJYYQE6TkAubFXOUFyUv5H21JIYGgRTU+i2bSOZYKFrNmjhV143gn/0J1zBnNpOzaPL2Es48w2aY6EJ4pFx3QOpWoUA4e03UcZzbVUv7w7c/isw7aCypGRVi+WdgxKUkKsLFKo="
-        - secure: "SSYizS83MBaq+apUQ8yylitSU6qu5dFrDk96wMeE7gEm6tjhh+JlyFnCqMNNyEpcgvK3s0NlGyt4yP0nMpF0ix3fGEXhLO2A82UDLYbTPFI+c2YHn8DAymg6dEzdIJ44LGzfkU/DFbIqQkvXmxvNP/3l2yXcGehRsHtuN4MEx4FBqT71c7rFKcBroEJl6t8FkV21VvhKUwJRJX5NsxI5+DGEHgvA41ZkTr+rxt+mx/8Y7cql27s0+ef7nKgvb13clFJy1WTa3t+eHuwdfS+6VlpHKk+v8eMddBFeOtAV9qSojGOiWutg3grLabvmJGWOUghUs0/gEYXpV2/MYR2aLdQC9DBB8bcxhsgebuqq8tMBISKzlqtsEAuA67CXMeMTwwhWQfIddim3192HFP0hfaNlqOYVnuYqo5HW8cyX4ek48aujaa2NTbPRqZ+xcVw0C5L8bs13NaaJeyGmVrIHfdvtKgj/PDhyosaH1fopaFjclJyryUV03AwznbcFFdD2bRZnKIq5xDcsVRN2tquAKHGd3n1NXf/vGIQP8KoxZgkF5Fa+FQaB4dlncba/l3x28N28CFSV4eG+0EYTxjRSW4ETJ66GqqgP5eH/NjdvDz7WKjHj7lXem4kewQ4Jq1Inrb8MsEpFhjQZCBHUgvGsLZP9PsZICukIzWsc4kVWXs4="
-          
-language: python
-sudo: false
-
-cache:
-  apt: true
-  directories:
-  - $HOME/.cache/pip
-  - $HOME/download
-  - $HOME/.pip-cache
-  - $HOME/gpg_install_prefix
-
-python:
-  - "3.8"
-  - "3.7"
-  - "2.7"
-  - "3.4"
-  - "3.5"
-  - "3.6"
-  #- "nightly"  # remove nightly for now
-
-before_install:
-  - pip install pip -U
-  - pip install -r requirements.txt -U
-
-install:
-  - travis_retry pip install -e .
-
-
-# Broken on pytest-cov-2.10.0
-# Broken on pytest==5.4.3
-# Broken on pytest==5.3.5
-# Broken on pytest==5.2.4
-#pip install pytest-cov==2.8.1
-#pip install pytest-cov==2.8.1
-#pip install pytest-cov==2.10.0
-    
-script: 
-  - pip uninstall pytest-cov -y
-  - pip install pytest-cov==2.8.1
-  - travis_wait pytest --cov=xdoctest
-
-after_success: 
-    - codecov 
-    - | 
-        __heredoc__='''
-        # HOW TO SETUP A GPG KEY
-        #
-        # References:
-        # .. [1] https://github.com/travis-ci/travis.rb
-        # .. [2] https://docs.travis-ci.com/user/encrypting-files/
-        #
-        # Note:
-        # You can set secret variables here in travis here:
-        #  https://travis-ci.org/Erotemic/xdoctest/settings
-
-        cd $HOME/code/xdoctest
-
-        # After you have setup your GPG key (plenty of resources on google about how to do this)
-        IDENTIFIER="travis-ci-Erotemic"
-        KEYID=$(gpg --list-keys --keyid-format LONG "$IDENTIFIER" | head -n 2 | tail -n 1 | awk '{print $1}' | tail -c 9)
-        echo "KEYID = $KEYID"
-
-        # Load or generate secrets
-        source $(secret_loader.sh)
-        echo $TWINE_USERNAME
-        echo $TWINE_PASSWORD
-        echo $CI_GITHUB_SECRET
-        
-        # encrypt relevant travis variables
-        # The following commands will output lines that will need to be
-        # manually added to this file. You could run with --add, but it messes
-        travis encrypt TWINE_USERNAME=$TWINE_USERNAME 
-        travis encrypt TWINE_PASSWORD=$TWINE_PASSWORD  
-        travis encrypt CI_GITHUB_SECRET=$CI_GITHUB_SECRET
-        
-        # Export plaintext gpg public keys, private keys, and trust info
-        mkdir -p dev
-        gpg --armor --export-secret-keys $KEYID > dev/travis_secret_gpg_key.pgp
-        gpg --armor --export $KEYID > dev/travis_public_gpg_key.pgp
-        gpg --export-ownertrust > dev/gpg_owner_trust
-
-        # Manually encrypt the secret files (TODO: need to vet this procedure)
-        echo $TRAVIS_SECRET
-        openssl aes-256-cbc -k $TRAVIS_SECRET -in dev/travis_public_gpg_key.pgp -e > dev/travis_public_gpg_key.pgp.enc
-        openssl aes-256-cbc -k $TRAVIS_SECRET -in dev/travis_secret_gpg_key.pgp -e > dev/travis_secret_gpg_key.pgp.enc
-        openssl aes-256-cbc -k $TRAVIS_SECRET -in dev/gpg_owner_trust -e > dev/gpg_owner_trust.enc
-
-
-        TSP=$TRAVIS_SECRET openssl enc -aes-256-cbc -md MD5 -pass env:TSP -e -a -in dev/travis_public_gpg_key.pgp > dev/travis_public_gpg_key.pgp.enc
-        TSP=$TRAVIS_SECRET openssl enc -aes-256-cbc -md MD5 -pass env:TSP -e -a -in dev/travis_secret_gpg_key.pgp > dev/travis_secret_gpg_key.pgp.enc
-        TSP=$TRAVIS_SECRET openssl enc -aes-256-cbc -md MD5 -pass env:TSP -e -a -in dev/gpg_owner_trust > dev/gpg_owner_trust.enc
-        echo $KEYID > dev/public_gpg_key
-
-        cat dev/travis_public_gpg_key.pgp.enc
-        cat dev/travis_secret_gpg_key.pgp.enc
-        cat dev/gpg_owner_trust.enc
-        cat dev/public_gpg_key
-
-        TSP=$TRAVIS_SECRET openssl enc -aes-256-cbc -md MD5 -pass env:TSP -d -a -in dev/travis_public_gpg_key.pgp.enc
-        TSP=$TRAVIS_SECRET openssl enc -aes-256-cbc -md MD5 -pass env:TSP -d -a -in dev/travis_secret_gpg_key.pgp.enc
-        TSP=$TRAVIS_SECRET openssl enc -aes-256-cbc -md MD5 -pass env:TSP -d -a -in dev/gpg_owner_trust.enc
-
-        # Export and encrpyt trust
-        #GPG_OWNERTRUST=$(gpg --export-ownertrust | base64)
-        #echo $GPG_OWNERTRUST
-        #echo "$GPG_OWNERTRUST" | base64 --decode
-        #travis encrypt GPG_OWNERTRUST="$GPG_OWNERTRUST"
-
-        # Note: cant do this. travis gives a data too large error
-        #GPG_SECRET_KEYS=$(gpg -a --export-secret-keys $IDENTIFIER | base64)
-        
-        # Look at what we did, clean up, and add it to git
-        ls dev/*.enc
-        rm dev/gpg_owner_trust dev/*.pgp
-        git status
-        git add dev/*.enc
-        git add dev/public_gpg_key
-        #travis encrypt GPG_SECRET_KEYS="$GPG_SECRET_KEYS"
-        #
-
-        AUTO-TAG NOTES:
-            To auto-tag a github hosted project we need to generate a personal
-            access token with write access.
-
-            First go to: 
-            https://github.com/settings/tokens/new
-
-            And create a token with "write:packages" checked. Name the token something like
-            github-push-token
-            copy that token and store it somewhere secure. 
-
-            PERSONAL_GITHUB_PUSH_TOKEN=<token-name>:<secret-value>
-
-            **If you did not add this encrypted variable as a secret**,
-            then also go to your github project settings page and add a
-            new secret variable named PERSONAL_GITHUB_PUSH_TOKEN with the
-            secret value.
-
-            <token-name>:<secret-value>
-
-            for example: github-push-token:ffjdksajklfdsjak
-
-            https://github.com/Erotemic/xdoctest/settings/secrets
-            
-            # Also here
-            https://travis-ci.org/github/Erotemic/xdoctest/settings
-
-            # Test that this works in a docker image
-            URL_HOST=$(git remote get-url origin | sed -e 's|https\?://.*@||g' | sed -e 's|https\?://||g')
-            echo "URL_HOST = $URL_HOST"
-            git config user.email "travis-ci@github.com"
-            git config user.name "Travis-CI"
-            git tag "test-tag-v5"
-            git push --tags "https://${PERSONAL_GITHUB_PUSH_TOKEN}@${URL_HOST}"
-        #
-        '''  # <hack vim "regex" parser> '
-    - gpg --version
-    - gpg2 --version
-    - export GPG_EXECUTABLE=gpg2
-    - openssl version
-    - |
-        # Install a more recent version of GPG
-        # https://gnupg.org/download/
-        export GPG_INSTALL_PREFIX=$HOME/gpg_install_prefix
-        export LD_LIBRARY_PATH=$GPG_INSTALL_PREFIX/lib:$LD_LIBRARY_PATH
-        export PATH=$GPG_INSTALL_PREFIX/bin:$PATH
-        export CPATH=$GPG_INSTALL_PREFIX/include:$CPATH
-        export GPG_EXECUTABLE=$GPG_INSTALL_PREFIX/bin/gpg
-        ls $GPG_INSTALL_PREFIX
-        ls $GPG_INSTALL_PREFIX/bin || echo "no bin"
-        if [[ ! -f "$GPG_INSTALL_PREFIX/bin/gpg" ]]; then
-            # try and have travis cache this
-            mkdir -p $GPG_INSTALL_PREFIX
-            echo $GPG_INSTALL_PREFIX
-            OLD=$(pwd)
-            cd $GPG_INSTALL_PREFIX
-            pip install ubelt
-
-            ERROR_FPATH=$(python -c "import ubelt as ub; print(ub.grabdata(
-                'https://gnupg.org/ftp/gcrypt/libgpg-error/libgpg-error-1.36.tar.bz2',
-                hash_prefix='6e5f853f77dc04f0091d94b224cab8e669042450f271b78d0ea0219',
-                dpath=ub.ensuredir('$HOME/.pip-cache'), verbose=0))")
-            GCRYPT_FPATH=$(python -c "import ubelt as ub; print(ub.grabdata(
-                'https://gnupg.org/ftp/gcrypt/libgcrypt/libgcrypt-1.8.5.tar.bz2',
-                hash_prefix='b55e16e838d1b1208e7673366971ae7c0f9c1c79e042f41c03d1',
-                dpath=ub.ensuredir('$HOME/.pip-cache'), verbose=0))")
-            KSBA_CRYPT_FPATH=$(python -c "import ubelt as ub; print(ub.grabdata(
-                'https://gnupg.org/ftp/gcrypt/libksba/libksba-1.3.5.tar.bz2',
-                hash_prefix='60179bfd109b7b4fd8d2b30a3216540f03f5a13620d9a5b63f1f95',
-                dpath=ub.ensuredir('$HOME/.pip-cache'), verbose=0))")
-            ASSUAN_FPATH=$(python -c "import ubelt as ub; print(ub.grabdata(
-                'https://gnupg.org/ftp/gcrypt/libassuan/libassuan-2.5.3.tar.bz2',
-                hash_prefix='e7ccb651ea75b07b2e687d48d86d0ab83cba8e2af7f30da2aec',
-                dpath=ub.ensuredir('$HOME/.pip-cache'), verbose=0))")
-            NTBLTLS_FPATH=$(python -c "import ubelt as ub; print(ub.grabdata(
-                'https://gnupg.org/ftp/gcrypt/ntbtls/ntbtls-0.1.2.tar.bz2',
-                hash_prefix='54468208359dc88155b14cba37773984d7d6f0f37c7a4ce13868d',
-                dpath=ub.ensuredir('$HOME/.pip-cache'), verbose=0))")
-            NPTH_FPATH=$(python -c "import ubelt as ub; print(ub.grabdata(
-                'https://gnupg.org/ftp/gcrypt/npth/npth-1.6.tar.bz2',
-                hash_prefix='2ed1012e14a9d10665420b9a23628be7e206fd9348111ec751349b',
-                dpath=ub.ensuredir('$HOME/.pip-cache'), verbose=0))")
-            GPG_FPATH=$(python -c "import ubelt as ub; print(ub.grabdata(
-                'https://gnupg.org/ftp/gcrypt/gnupg/gnupg-2.2.17.tar.bz2',
-                hash_prefix='a3cd094addac62b4b4ec1683005a2bec761ea2aacf6daf904316b',
-                dpath=ub.ensuredir('$HOME/.pip-cache'), verbose=0))")
-
-            tar xjf $ERROR_FPATH
-            tar xjf $GCRYPT_FPATH
-            tar xjf $KSBA_CRYPT_FPATH
-            tar xjf $ASSUAN_FPATH
-            tar xjf $NTBLTLS_FPATH
-            tar xjf $NPTH_FPATH
-            tar xjf $GPG_FPATH
-            (cd libgpg-error-1.36 && ./configure --prefix=$GPG_INSTALL_PREFIX && make install)
-            (cd libgcrypt-1.8.5 && ./configure --prefix=$GPG_INSTALL_PREFIX && make install)
-            (cd libksba-1.3.5 && ./configure --prefix=$GPG_INSTALL_PREFIX && make install)
-            (cd libassuan-2.5.3 && ./configure --prefix=$GPG_INSTALL_PREFIX && make install)
-            (cd ntbtls-0.1.2 && ./configure --prefix=$GPG_INSTALL_PREFIX && make install)
-            (cd npth-1.6 && ./configure --prefix=$GPG_INSTALL_PREFIX && make install)
-            (cd gnupg-2.2.17 && ./configure --prefix=$GPG_INSTALL_PREFIX && make install)
-            echo "GPG_EXECUTABLE = '$GPG_EXECUTABLE'"
-            cd $OLD
-        fi
-    # Decrypt and import GPG Keys / trust
-    - $GPG_EXECUTABLE --version
-    - openssl version
-    - $GPG_EXECUTABLE --list-keys
-    - TSP=$TRAVIS_SECRET openssl enc -aes-256-cbc -md MD5 -pass env:TSP -d -a -in dev/travis_public_gpg_key.pgp.enc | $GPG_EXECUTABLE --import 
-    - TSP=$TRAVIS_SECRET openssl enc -aes-256-cbc -md MD5 -pass env:TSP -d -a -in dev/travis_secret_gpg_key.pgp.enc | $GPG_EXECUTABLE --import 
-    - TSP=$TRAVIS_SECRET openssl enc -aes-256-cbc -md MD5 -pass env:TSP -d -a -in dev/gpg_owner_trust.enc | $GPG_EXECUTABLE --import-ownertrust
-    - $GPG_EXECUTABLE --list-keys
-    - |
-        pip install twine
-        if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
-          pip install six pyopenssl ndg-httpsclient pyasn1 -U --user
-          pip install requests[security] twine --user
-        elfi
-        if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then
-          pip install six twine
-          pip install --upgrade pyOpenSSL
-        fi
-    # Package and publish to pypi (if on release)
-    - |
-        echo "TRAVIS_BRANCH = $TRAVIS_BRANCH"
-        if [[ "$TRAVIS_BRANCH" == "release" ]]; then
-            TAG_AND_UPLOAD=yes
-        else
-            TAG_AND_UPLOAD=no
-        fi
-        KEYID=$(cat dev/public_gpg_key)
-        echo "KEYID = '$KEYID'"
-        MB_PYTHON_TAG=$MB_PYTHON_TAG \
-            USE_GPG=True \
-            GPG_KEYID=$KEYID \
-            CURRENT_BRANCH=$TRAVIS_BRANCH \
-            TWINE_PASSWORD=$TWINE_PASSWORD \
-            TWINE_USERNAME=$TWINE_USERNAME \
-            GPG_EXECUTABLE=$GPG_EXECUTABLE \
-            DEPLOY_BRANCH=release \
-            TAG_AND_UPLOAD=$TAG_AND_UPLOAD \
-            ./publish.sh
-
-        # TODO: incorporate git tagging into release script 
-        if [[ "$TRAVIS_BRANCH" == "release" ]]; then
-            URL_HOST=$(git remote get-url origin | sed -e 's|https\?://.*@||g' | sed -e 's|https\?://||g')
-            echo "URL_HOST = $URL_HOST"
-            git config user.email "travis-ci@github.com"
-            git config user.name "Travis-CI"
-            VERSION=$(python -c "import setup; print(setup.VERSION)")
-            git tag $VERSION -m "tarball tag $VERSION"
-            git push --tags "https://${PERSONAL_GITHUB_PUSH_TOKEN}@${URL_HOST}"
-        fi
diff --git a/dev/make_strict_req.sh b/dev/make_strict_req.sh
deleted file mode 100644
index fd1e7b9c..00000000
--- a/dev/make_strict_req.sh
+++ /dev/null
@@ -1,14 +0,0 @@
-#!/bin/bash
-__doc__="""
-Make a strict version of requirements
-
-./dev/make_strict_req.sh
-"""
-mkdir -p requirements-strict
-sed 's/>=/==/' requirements/runtime.txt > requirements-strict/runtime.txt
-sed 's/>=/==/' requirements/colors.txt > requirements-strict/colors.txt
-sed 's/>=/==/' requirements/jupyter.txt > requirements-strict/jupyter.txt
-sed 's/>=/==/' requirements/problematic.txt > requirements-strict/problematic.txt
-sed 's/>=/==/' requirements/optional.txt > requirements-strict/optional.txt
-sed 's/>=/==/' requirements/tests.txt > requirements-strict/tests.txt
-sed 's/requirements/requirements-strict/' requirements.txt > requirements-strict.txt
diff --git a/pyproject.toml b/pyproject.toml
index 908c624f..3e7f14ba 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -8,13 +8,48 @@ ignore_missing_imports = true
 tags = [ "erotemic", "github", "purepy",]
 mod_name = "xdoctest"
 repo_name = "xdoctest"
-rel_mod_parent_dpath = "."
+rel_mod_parent_dpath = "./src"
 os = [ "all", "win", "linux", "osx",]
 min_python = 2.7
 author = "Jon Crall"
 author_email = "erotemic@gmail.com"
-description = "A module cut from xcookie"
+description = "A rewrite of the builtin doctest module"
+url = "https://github.com/Erotemic/xdoctest"
 license = "Apache 2"
+dev_status = "stable"
+classifiers = [
+    'Development Status :: 5 - Production/Stable',
+    'Intended Audience :: Developers',
+    'Topic :: Software Development :: Libraries :: Python Modules',
+    'Topic :: Utilities',
+    'Topic :: Software Development :: Testing',
+    'Framework :: Pytest',
+    # This should be interpreted as Apache License v2.0
+    'License :: OSI Approved :: Apache Software License',
+    # Supported Python versions
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.7',
+    'Programming Language :: Python :: 3.6',
+    'Programming Language :: Python :: 3.5',
+    'Programming Language :: Python :: 3.4',
+    'Programming Language :: Python :: 2.7',
+    'Programming Language :: Python :: Implementation :: PyPy',
+    'Programming Language :: Python :: Implementation :: CPython',
+]
+
+[tool.xcookie.entry_points]
+# the pytest11 entry point makes the plugin available to pytest
+pytest11 = [
+    "xdoctest = xdoctest.plugin",
+]
+# the console_scripts entry point creates the xdoctest executable
+console_scripts = [
+    "xdoctest = xdoctest.__main__:main",
+]
+
 
 [tool.pytest.ini_options]
 addopts = "-p no:doctest --xdoctest --xdoctest-style=google --ignore-glob=setup.py --ignore-glob=dev"
diff --git a/setup.py b/setup.py
index ee3ed80d..f063cad3 100755
--- a/setup.py
+++ b/setup.py
@@ -178,17 +178,9 @@ def gen_packages_items():
 
 
 if __name__ == '__main__':
-    setupkw = dict(
-        name=NAME,
-        version=VERSION,
-        author='Jon Crall',
-        author_email='erotemic@gmail.com',
-        url='https://github.com/Erotemic/xdoctest',
-        license='Apache 2',
-    )
-
-    setupkw["install_requires"] = parse_requirements("requirements/runtime.txt")
-    setupkw["extras_require"] = {
+    setupkw = {}
+    setupkw['install_requires'] = parse_requirements('requirements/runtime.txt')
+    setupkw['extras_require'] = {
         "all": parse_requirements("requirements.txt"),
         "tests": parse_requirements("requirements/tests.txt"),
         "optional": parse_requirements("requirements/optional.txt"),
@@ -202,53 +194,52 @@ def gen_packages_items():
         ),
         'colors': parse_requirements('requirements/colors.txt'),
         'jupyter': parse_requirements('requirements/jupyter.txt'),
+        }
+
+    setupkw['name'] = NAME
+    setupkw['version'] = VERSION
+    setupkw['author'] = 'Jon Crall'
+    setupkw['author_email'] = 'erotemic@gmail.com'
+    setupkw['url'] = 'https://github.com/Erotemic/xdoctest'
+    setupkw['description'] = 'A rewrite of the builtin doctest module'
+    setupkw['long_description'] = parse_description()
+    setupkw['long_description_content_type'] = 'text/x-rst'
+    setupkw['license'] = 'Apache 2'
+    setupkw['packages'] = find_packages('.')
+    setupkw['python_requires'] = '>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*'
+    setupkw['classifiers'] = [
+        'Development Status :: 5 - Production/Stable',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Topic :: Utilities',
+        'Topic :: Software Development :: Testing',
+        'Framework :: Pytest',
+        # This should be interpreted as Apache License v2.0
+        'License :: OSI Approved :: Apache Software License',
+        # Supported Python versions
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: Implementation :: PyPy',
+        'Programming Language :: Python :: Implementation :: CPython',
+    ]
+    setupkw['package_dir'] = {
+        '': './src',
     }
-
-    setupkw.update(dict(
-        description='A rewrite of the builtin doctest module',
-        long_description=parse_description(),
-        long_description_content_type='text/x-rst',
-        entry_points={
-            # the pytest11 entry point makes the plugin available to pytest
-            'pytest11': [
-                'xdoctest = xdoctest.plugin',
-            ],
-            # the console_scripts entry point creates the xdoctest executable
-            'console_scripts': [
-                'xdoctest = xdoctest.__main__:main'
-            ]
-        },
-        packages=find_packages('.'),
-        # packages=['xdoctest', 'xdoctest.utils', 'xdoctest.docstr'],
-        # custom PyPI classifier for pytest plugins
-        # python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*',
-        python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*',
-        package_data={
-            'xdoctest': ['py.typed', '*.pyi'],
-        },
-        classifiers=[
-            'Development Status :: 5 - Production/Stable',
-            'Intended Audience :: Developers',
-            'Topic :: Software Development :: Libraries :: Python Modules',
-            'Topic :: Utilities',
-            'Topic :: Software Development :: Testing',
-            'Framework :: Pytest',
-            # This should be interpreted as Apache License v2.0
-            'License :: OSI Approved :: Apache Software License',
-            # Supported Python versions
-            'Programming Language :: Python :: 3',
-            'Programming Language :: Python :: 3.10',
-            'Programming Language :: Python :: 3.9',
-            'Programming Language :: Python :: 3.8',
-            'Programming Language :: Python :: 3.7',
-            'Programming Language :: Python :: 3.6',
-            'Programming Language :: Python :: 3.5',
-            'Programming Language :: Python :: 3.4',
-            'Programming Language :: Python :: 2.7',
-            'Programming Language :: Python :: Implementation :: PyPy',
-            'Programming Language :: Python :: Implementation :: CPython',
+    setupkw['entry_points'] = {
+        'console_scripts': [
+            'xdoctest = xdoctest.__main__:main',
+        ],
+        'pytest11': [
+            'xdoctest = xdoctest.plugin',
         ],
-    ))
+    }
     if sys.version_info[0] == 3 and sys.version_info[1] <= 4:
         setupkw.pop('long_description_content_type', None)
     setup(**setupkw)
diff --git a/xdoctest/__init__.py b/xdoctest/__init__.py
index d83397ff..3395aeb9 100644
--- a/xdoctest/__init__.py
+++ b/xdoctest/__init__.py
@@ -336,7 +336,7 @@ def _parse_changelog(fpath):
     Helper to parse the changelog for the version to verify versions agree.
 
     CommandLine:
-        xdoctest ~/code/xdoctest/xdoctest/__init__.py _parse_changelog --dev
+        xdoctest -m xdoctest.__init__ _parse_changelog --dev
 
     Example:
         >>> # xdoctest: +REQUIRES(--dev)
diff --git a/xdoctest/__main__.py b/xdoctest/__main__.py
index f4b02e7d..a6e11ae2 100644
--- a/xdoctest/__main__.py
+++ b/xdoctest/__main__.py
@@ -14,7 +14,7 @@
 Ignore:
 
     xdoctest -m xdoctest.demo
-    xdoctest ~/code/xdoctest/xdoctest/demo.py
+    xdoctest ~/code/xdoctest/src/xdoctest/demo.py
     python -m xdoctest xdoctest all
     python -m xdoctest networkx all --options=+IGNORE_WHITESPACE
 """
diff --git a/xdoctest/doctest_example.py b/xdoctest/doctest_example.py
index 4afe17e2..516ab7ad 100644
--- a/xdoctest/doctest_example.py
+++ b/xdoctest/doctest_example.py
@@ -1165,11 +1165,8 @@ def overwrite_lineno(linepart):
                         #     # not sure if this should be removed or not
                         #     continue
 
-                        # if 'xdoctest/utils/util_import' in line:
-                        #     # hack, remove ourselves from the tracback
-                        #     continue
-
-                        if 1:
+                        if 0:
+                            # Not a robust acheck
                             if 'xdoctest/xdoctest/doctest_example' in line:
                                 # hack, remove ourselves from the tracback
                                 continue
diff --git a/xdoctest/dynamic_analysis.py b/xdoctest/dynamic_analysis.py
index b738e105..a94cdfc5 100644
--- a/xdoctest/dynamic_analysis.py
+++ b/xdoctest/dynamic_analysis.py
@@ -50,6 +50,7 @@ def parse_dynamic_calldefs(modpath_or_module):
         modpath = modpath_or_module
         if modpath.endswith('.ipynb'):
             """
+            # Devnote:
             modpath = ub.expandpath("~/code/xdoctest/tests/notebook_with_doctests.ipynb")
             xdoctest ~/code/xdoctest/tests/notebook_with_doctests.ipynb
             """
diff --git a/xdoctest/runner.py b/xdoctest/runner.py
index a716bfed..469b52f8 100644
--- a/xdoctest/runner.py
+++ b/xdoctest/runner.py
@@ -163,7 +163,7 @@ def doctest_module(module_identifier=None, command=None, argv=None, exclude=[],
         >>> result = doctest_module('xdoctest.static_analysis')
         >>> #
         >>> # Using a module path
-        >>> result = doctest_module(os.expandpath('~/code/xdoctest/xdoctest/static_analysis.py'))
+        >>> result = doctest_module(os.expandpath('~/code/xdoctest/src/xdoctest/static_analysis.py'))
         >>> #
         >>> # Using a module itself
         >>> from xdoctest import runner
diff --git a/xdoctest/static_analysis.py b/xdoctest/static_analysis.py
index fc03459a..e97fe594 100644
--- a/xdoctest/static_analysis.py
+++ b/xdoctest/static_analysis.py
@@ -626,7 +626,7 @@ def func7():
     def _get_docstring(self, node):
         """
         CommandLine:
-            xdoctest -m ~/code/xdoctest/xdoctest/static_analysis.py TopLevelVisitor._get_docstring
+            xdoctest -m xdoctest.static_analysis.py TopLevelVisitor._get_docstring
 
         Example:
             >>> source = utils.codeblock(

From f66ea6cd68adf9d9563b9ce85aab5b4bc0d874f2 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 13:36:13 -0400
Subject: [PATCH 31/38] move library code into the src directory

---
 {xdoctest => src/xdoctest}/__init__.py                 | 0
 {xdoctest => src/xdoctest}/__main__.py                 | 0
 {xdoctest => src/xdoctest}/__main__.pyi                | 0
 {xdoctest => src/xdoctest}/checker.py                  | 0
 {xdoctest => src/xdoctest}/checker.pyi                 | 0
 {xdoctest => src/xdoctest}/constants.py                | 0
 {xdoctest => src/xdoctest}/constants.pyi               | 0
 {xdoctest => src/xdoctest}/core.py                     | 0
 {xdoctest => src/xdoctest}/core.pyi                    | 0
 {xdoctest => src/xdoctest}/demo.py                     | 0
 {xdoctest => src/xdoctest}/demo.pyi                    | 0
 {xdoctest => src/xdoctest}/directive.py                | 0
 {xdoctest => src/xdoctest}/directive.pyi               | 0
 {xdoctest => src/xdoctest}/docstr/__init__.py          | 0
 {xdoctest => src/xdoctest}/docstr/docscrape_google.py  | 0
 {xdoctest => src/xdoctest}/docstr/docscrape_google.pyi | 0
 {xdoctest => src/xdoctest}/docstr/docscrape_numpy.py   | 0
 {xdoctest => src/xdoctest}/docstr/docscrape_numpy.pyi  | 0
 {xdoctest => src/xdoctest}/doctest_example.py          | 0
 {xdoctest => src/xdoctest}/doctest_example.pyi         | 0
 {xdoctest => src/xdoctest}/doctest_part.py             | 0
 {xdoctest => src/xdoctest}/doctest_part.pyi            | 0
 {xdoctest => src/xdoctest}/dynamic_analysis.py         | 0
 {xdoctest => src/xdoctest}/dynamic_analysis.pyi        | 0
 {xdoctest => src/xdoctest}/exceptions.py               | 0
 {xdoctest => src/xdoctest}/exceptions.pyi              | 0
 {xdoctest => src/xdoctest}/global_state.py             | 0
 {xdoctest => src/xdoctest}/global_state.pyi            | 0
 {xdoctest => src/xdoctest}/parser.py                   | 0
 {xdoctest => src/xdoctest}/parser.pyi                  | 0
 {xdoctest => src/xdoctest}/plugin.py                   | 0
 {xdoctest => src/xdoctest}/plugin.pyi                  | 0
 {xdoctest => src/xdoctest}/py.typed                    | 0
 {xdoctest => src/xdoctest}/runner.py                   | 0
 {xdoctest => src/xdoctest}/runner.pyi                  | 0
 {xdoctest => src/xdoctest}/static_analysis.py          | 0
 {xdoctest => src/xdoctest}/static_analysis.pyi         | 0
 {xdoctest => src/xdoctest}/utils/__init__.py           | 0
 {xdoctest => src/xdoctest}/utils/util_deprecation.py   | 0
 {xdoctest => src/xdoctest}/utils/util_deprecation.pyi  | 0
 {xdoctest => src/xdoctest}/utils/util_import.py        | 0
 {xdoctest => src/xdoctest}/utils/util_import.pyi       | 0
 {xdoctest => src/xdoctest}/utils/util_misc.py          | 0
 {xdoctest => src/xdoctest}/utils/util_misc.pyi         | 0
 {xdoctest => src/xdoctest}/utils/util_mixins.py        | 0
 {xdoctest => src/xdoctest}/utils/util_mixins.pyi       | 0
 {xdoctest => src/xdoctest}/utils/util_notebook.py      | 0
 {xdoctest => src/xdoctest}/utils/util_notebook.pyi     | 0
 {xdoctest => src/xdoctest}/utils/util_path.py          | 0
 {xdoctest => src/xdoctest}/utils/util_path.pyi         | 0
 {xdoctest => src/xdoctest}/utils/util_str.py           | 0
 {xdoctest => src/xdoctest}/utils/util_str.pyi          | 0
 {xdoctest => src/xdoctest}/utils/util_stream.py        | 0
 {xdoctest => src/xdoctest}/utils/util_stream.pyi       | 0
 54 files changed, 0 insertions(+), 0 deletions(-)
 rename {xdoctest => src/xdoctest}/__init__.py (100%)
 rename {xdoctest => src/xdoctest}/__main__.py (100%)
 rename {xdoctest => src/xdoctest}/__main__.pyi (100%)
 rename {xdoctest => src/xdoctest}/checker.py (100%)
 rename {xdoctest => src/xdoctest}/checker.pyi (100%)
 rename {xdoctest => src/xdoctest}/constants.py (100%)
 rename {xdoctest => src/xdoctest}/constants.pyi (100%)
 rename {xdoctest => src/xdoctest}/core.py (100%)
 rename {xdoctest => src/xdoctest}/core.pyi (100%)
 rename {xdoctest => src/xdoctest}/demo.py (100%)
 rename {xdoctest => src/xdoctest}/demo.pyi (100%)
 rename {xdoctest => src/xdoctest}/directive.py (100%)
 rename {xdoctest => src/xdoctest}/directive.pyi (100%)
 rename {xdoctest => src/xdoctest}/docstr/__init__.py (100%)
 rename {xdoctest => src/xdoctest}/docstr/docscrape_google.py (100%)
 rename {xdoctest => src/xdoctest}/docstr/docscrape_google.pyi (100%)
 rename {xdoctest => src/xdoctest}/docstr/docscrape_numpy.py (100%)
 rename {xdoctest => src/xdoctest}/docstr/docscrape_numpy.pyi (100%)
 rename {xdoctest => src/xdoctest}/doctest_example.py (100%)
 rename {xdoctest => src/xdoctest}/doctest_example.pyi (100%)
 rename {xdoctest => src/xdoctest}/doctest_part.py (100%)
 rename {xdoctest => src/xdoctest}/doctest_part.pyi (100%)
 rename {xdoctest => src/xdoctest}/dynamic_analysis.py (100%)
 rename {xdoctest => src/xdoctest}/dynamic_analysis.pyi (100%)
 rename {xdoctest => src/xdoctest}/exceptions.py (100%)
 rename {xdoctest => src/xdoctest}/exceptions.pyi (100%)
 rename {xdoctest => src/xdoctest}/global_state.py (100%)
 rename {xdoctest => src/xdoctest}/global_state.pyi (100%)
 rename {xdoctest => src/xdoctest}/parser.py (100%)
 rename {xdoctest => src/xdoctest}/parser.pyi (100%)
 rename {xdoctest => src/xdoctest}/plugin.py (100%)
 rename {xdoctest => src/xdoctest}/plugin.pyi (100%)
 rename {xdoctest => src/xdoctest}/py.typed (100%)
 rename {xdoctest => src/xdoctest}/runner.py (100%)
 rename {xdoctest => src/xdoctest}/runner.pyi (100%)
 rename {xdoctest => src/xdoctest}/static_analysis.py (100%)
 rename {xdoctest => src/xdoctest}/static_analysis.pyi (100%)
 rename {xdoctest => src/xdoctest}/utils/__init__.py (100%)
 rename {xdoctest => src/xdoctest}/utils/util_deprecation.py (100%)
 rename {xdoctest => src/xdoctest}/utils/util_deprecation.pyi (100%)
 rename {xdoctest => src/xdoctest}/utils/util_import.py (100%)
 rename {xdoctest => src/xdoctest}/utils/util_import.pyi (100%)
 rename {xdoctest => src/xdoctest}/utils/util_misc.py (100%)
 rename {xdoctest => src/xdoctest}/utils/util_misc.pyi (100%)
 rename {xdoctest => src/xdoctest}/utils/util_mixins.py (100%)
 rename {xdoctest => src/xdoctest}/utils/util_mixins.pyi (100%)
 rename {xdoctest => src/xdoctest}/utils/util_notebook.py (100%)
 rename {xdoctest => src/xdoctest}/utils/util_notebook.pyi (100%)
 rename {xdoctest => src/xdoctest}/utils/util_path.py (100%)
 rename {xdoctest => src/xdoctest}/utils/util_path.pyi (100%)
 rename {xdoctest => src/xdoctest}/utils/util_str.py (100%)
 rename {xdoctest => src/xdoctest}/utils/util_str.pyi (100%)
 rename {xdoctest => src/xdoctest}/utils/util_stream.py (100%)
 rename {xdoctest => src/xdoctest}/utils/util_stream.pyi (100%)

diff --git a/xdoctest/__init__.py b/src/xdoctest/__init__.py
similarity index 100%
rename from xdoctest/__init__.py
rename to src/xdoctest/__init__.py
diff --git a/xdoctest/__main__.py b/src/xdoctest/__main__.py
similarity index 100%
rename from xdoctest/__main__.py
rename to src/xdoctest/__main__.py
diff --git a/xdoctest/__main__.pyi b/src/xdoctest/__main__.pyi
similarity index 100%
rename from xdoctest/__main__.pyi
rename to src/xdoctest/__main__.pyi
diff --git a/xdoctest/checker.py b/src/xdoctest/checker.py
similarity index 100%
rename from xdoctest/checker.py
rename to src/xdoctest/checker.py
diff --git a/xdoctest/checker.pyi b/src/xdoctest/checker.pyi
similarity index 100%
rename from xdoctest/checker.pyi
rename to src/xdoctest/checker.pyi
diff --git a/xdoctest/constants.py b/src/xdoctest/constants.py
similarity index 100%
rename from xdoctest/constants.py
rename to src/xdoctest/constants.py
diff --git a/xdoctest/constants.pyi b/src/xdoctest/constants.pyi
similarity index 100%
rename from xdoctest/constants.pyi
rename to src/xdoctest/constants.pyi
diff --git a/xdoctest/core.py b/src/xdoctest/core.py
similarity index 100%
rename from xdoctest/core.py
rename to src/xdoctest/core.py
diff --git a/xdoctest/core.pyi b/src/xdoctest/core.pyi
similarity index 100%
rename from xdoctest/core.pyi
rename to src/xdoctest/core.pyi
diff --git a/xdoctest/demo.py b/src/xdoctest/demo.py
similarity index 100%
rename from xdoctest/demo.py
rename to src/xdoctest/demo.py
diff --git a/xdoctest/demo.pyi b/src/xdoctest/demo.pyi
similarity index 100%
rename from xdoctest/demo.pyi
rename to src/xdoctest/demo.pyi
diff --git a/xdoctest/directive.py b/src/xdoctest/directive.py
similarity index 100%
rename from xdoctest/directive.py
rename to src/xdoctest/directive.py
diff --git a/xdoctest/directive.pyi b/src/xdoctest/directive.pyi
similarity index 100%
rename from xdoctest/directive.pyi
rename to src/xdoctest/directive.pyi
diff --git a/xdoctest/docstr/__init__.py b/src/xdoctest/docstr/__init__.py
similarity index 100%
rename from xdoctest/docstr/__init__.py
rename to src/xdoctest/docstr/__init__.py
diff --git a/xdoctest/docstr/docscrape_google.py b/src/xdoctest/docstr/docscrape_google.py
similarity index 100%
rename from xdoctest/docstr/docscrape_google.py
rename to src/xdoctest/docstr/docscrape_google.py
diff --git a/xdoctest/docstr/docscrape_google.pyi b/src/xdoctest/docstr/docscrape_google.pyi
similarity index 100%
rename from xdoctest/docstr/docscrape_google.pyi
rename to src/xdoctest/docstr/docscrape_google.pyi
diff --git a/xdoctest/docstr/docscrape_numpy.py b/src/xdoctest/docstr/docscrape_numpy.py
similarity index 100%
rename from xdoctest/docstr/docscrape_numpy.py
rename to src/xdoctest/docstr/docscrape_numpy.py
diff --git a/xdoctest/docstr/docscrape_numpy.pyi b/src/xdoctest/docstr/docscrape_numpy.pyi
similarity index 100%
rename from xdoctest/docstr/docscrape_numpy.pyi
rename to src/xdoctest/docstr/docscrape_numpy.pyi
diff --git a/xdoctest/doctest_example.py b/src/xdoctest/doctest_example.py
similarity index 100%
rename from xdoctest/doctest_example.py
rename to src/xdoctest/doctest_example.py
diff --git a/xdoctest/doctest_example.pyi b/src/xdoctest/doctest_example.pyi
similarity index 100%
rename from xdoctest/doctest_example.pyi
rename to src/xdoctest/doctest_example.pyi
diff --git a/xdoctest/doctest_part.py b/src/xdoctest/doctest_part.py
similarity index 100%
rename from xdoctest/doctest_part.py
rename to src/xdoctest/doctest_part.py
diff --git a/xdoctest/doctest_part.pyi b/src/xdoctest/doctest_part.pyi
similarity index 100%
rename from xdoctest/doctest_part.pyi
rename to src/xdoctest/doctest_part.pyi
diff --git a/xdoctest/dynamic_analysis.py b/src/xdoctest/dynamic_analysis.py
similarity index 100%
rename from xdoctest/dynamic_analysis.py
rename to src/xdoctest/dynamic_analysis.py
diff --git a/xdoctest/dynamic_analysis.pyi b/src/xdoctest/dynamic_analysis.pyi
similarity index 100%
rename from xdoctest/dynamic_analysis.pyi
rename to src/xdoctest/dynamic_analysis.pyi
diff --git a/xdoctest/exceptions.py b/src/xdoctest/exceptions.py
similarity index 100%
rename from xdoctest/exceptions.py
rename to src/xdoctest/exceptions.py
diff --git a/xdoctest/exceptions.pyi b/src/xdoctest/exceptions.pyi
similarity index 100%
rename from xdoctest/exceptions.pyi
rename to src/xdoctest/exceptions.pyi
diff --git a/xdoctest/global_state.py b/src/xdoctest/global_state.py
similarity index 100%
rename from xdoctest/global_state.py
rename to src/xdoctest/global_state.py
diff --git a/xdoctest/global_state.pyi b/src/xdoctest/global_state.pyi
similarity index 100%
rename from xdoctest/global_state.pyi
rename to src/xdoctest/global_state.pyi
diff --git a/xdoctest/parser.py b/src/xdoctest/parser.py
similarity index 100%
rename from xdoctest/parser.py
rename to src/xdoctest/parser.py
diff --git a/xdoctest/parser.pyi b/src/xdoctest/parser.pyi
similarity index 100%
rename from xdoctest/parser.pyi
rename to src/xdoctest/parser.pyi
diff --git a/xdoctest/plugin.py b/src/xdoctest/plugin.py
similarity index 100%
rename from xdoctest/plugin.py
rename to src/xdoctest/plugin.py
diff --git a/xdoctest/plugin.pyi b/src/xdoctest/plugin.pyi
similarity index 100%
rename from xdoctest/plugin.pyi
rename to src/xdoctest/plugin.pyi
diff --git a/xdoctest/py.typed b/src/xdoctest/py.typed
similarity index 100%
rename from xdoctest/py.typed
rename to src/xdoctest/py.typed
diff --git a/xdoctest/runner.py b/src/xdoctest/runner.py
similarity index 100%
rename from xdoctest/runner.py
rename to src/xdoctest/runner.py
diff --git a/xdoctest/runner.pyi b/src/xdoctest/runner.pyi
similarity index 100%
rename from xdoctest/runner.pyi
rename to src/xdoctest/runner.pyi
diff --git a/xdoctest/static_analysis.py b/src/xdoctest/static_analysis.py
similarity index 100%
rename from xdoctest/static_analysis.py
rename to src/xdoctest/static_analysis.py
diff --git a/xdoctest/static_analysis.pyi b/src/xdoctest/static_analysis.pyi
similarity index 100%
rename from xdoctest/static_analysis.pyi
rename to src/xdoctest/static_analysis.pyi
diff --git a/xdoctest/utils/__init__.py b/src/xdoctest/utils/__init__.py
similarity index 100%
rename from xdoctest/utils/__init__.py
rename to src/xdoctest/utils/__init__.py
diff --git a/xdoctest/utils/util_deprecation.py b/src/xdoctest/utils/util_deprecation.py
similarity index 100%
rename from xdoctest/utils/util_deprecation.py
rename to src/xdoctest/utils/util_deprecation.py
diff --git a/xdoctest/utils/util_deprecation.pyi b/src/xdoctest/utils/util_deprecation.pyi
similarity index 100%
rename from xdoctest/utils/util_deprecation.pyi
rename to src/xdoctest/utils/util_deprecation.pyi
diff --git a/xdoctest/utils/util_import.py b/src/xdoctest/utils/util_import.py
similarity index 100%
rename from xdoctest/utils/util_import.py
rename to src/xdoctest/utils/util_import.py
diff --git a/xdoctest/utils/util_import.pyi b/src/xdoctest/utils/util_import.pyi
similarity index 100%
rename from xdoctest/utils/util_import.pyi
rename to src/xdoctest/utils/util_import.pyi
diff --git a/xdoctest/utils/util_misc.py b/src/xdoctest/utils/util_misc.py
similarity index 100%
rename from xdoctest/utils/util_misc.py
rename to src/xdoctest/utils/util_misc.py
diff --git a/xdoctest/utils/util_misc.pyi b/src/xdoctest/utils/util_misc.pyi
similarity index 100%
rename from xdoctest/utils/util_misc.pyi
rename to src/xdoctest/utils/util_misc.pyi
diff --git a/xdoctest/utils/util_mixins.py b/src/xdoctest/utils/util_mixins.py
similarity index 100%
rename from xdoctest/utils/util_mixins.py
rename to src/xdoctest/utils/util_mixins.py
diff --git a/xdoctest/utils/util_mixins.pyi b/src/xdoctest/utils/util_mixins.pyi
similarity index 100%
rename from xdoctest/utils/util_mixins.pyi
rename to src/xdoctest/utils/util_mixins.pyi
diff --git a/xdoctest/utils/util_notebook.py b/src/xdoctest/utils/util_notebook.py
similarity index 100%
rename from xdoctest/utils/util_notebook.py
rename to src/xdoctest/utils/util_notebook.py
diff --git a/xdoctest/utils/util_notebook.pyi b/src/xdoctest/utils/util_notebook.pyi
similarity index 100%
rename from xdoctest/utils/util_notebook.pyi
rename to src/xdoctest/utils/util_notebook.pyi
diff --git a/xdoctest/utils/util_path.py b/src/xdoctest/utils/util_path.py
similarity index 100%
rename from xdoctest/utils/util_path.py
rename to src/xdoctest/utils/util_path.py
diff --git a/xdoctest/utils/util_path.pyi b/src/xdoctest/utils/util_path.pyi
similarity index 100%
rename from xdoctest/utils/util_path.pyi
rename to src/xdoctest/utils/util_path.pyi
diff --git a/xdoctest/utils/util_str.py b/src/xdoctest/utils/util_str.py
similarity index 100%
rename from xdoctest/utils/util_str.py
rename to src/xdoctest/utils/util_str.py
diff --git a/xdoctest/utils/util_str.pyi b/src/xdoctest/utils/util_str.pyi
similarity index 100%
rename from xdoctest/utils/util_str.pyi
rename to src/xdoctest/utils/util_str.pyi
diff --git a/xdoctest/utils/util_stream.py b/src/xdoctest/utils/util_stream.py
similarity index 100%
rename from xdoctest/utils/util_stream.py
rename to src/xdoctest/utils/util_stream.py
diff --git a/xdoctest/utils/util_stream.pyi b/src/xdoctest/utils/util_stream.pyi
similarity index 100%
rename from xdoctest/utils/util_stream.pyi
rename to src/xdoctest/utils/util_stream.pyi

From 74a3eeec8cb2ac2839190b0e34dd946d0cf1fc8a Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 13:53:40 -0400
Subject: [PATCH 32/38] Finish src reorganization

---
 CHANGELOG.md    |   2 +
 pyproject.toml  |   1 +
 run_doctests.sh |   2 +-
 run_linter.sh   |   2 +-
 run_tests.py    |   2 +-
 setup.py        | 109 ++++++++++++++++++++++++------------------------
 6 files changed, 60 insertions(+), 58 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 39558f65..aa1b06d7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -23,6 +23,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
   args blocks. This has also moved to the standalone package `googledoc`
 * Overhaul of repo structure in an effort to modernize and to agree with
   templates defined by xcookie
+* Module code now lives in the "src" directory to remove install vs develop
+  ambiguity.
 
 
 
diff --git a/pyproject.toml b/pyproject.toml
index 3e7f14ba..043d000d 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,5 +1,6 @@
 [build-system]
 requires = [ "setuptools>=41.0.1",]
+build-backend = "setuptools.build_meta"
 
 [tool.mypy]
 ignore_missing_imports = true
diff --git a/run_doctests.sh b/run_doctests.sh
index 3b6d0645..1a60eebd 100755
--- a/run_doctests.sh
+++ b/run_doctests.sh
@@ -1,2 +1,2 @@
 #!/bin/bash
-xdoctest xdoctest --style=google all "$@"
+xdoctest ./src/xdoctest --style=google all "$@"
diff --git a/run_linter.sh b/run_linter.sh
index 0787f081..008d7070 100755
--- a/run_linter.sh
+++ b/run_linter.sh
@@ -1,2 +1,2 @@
 #!/bin/bash
-flake8 ./xdoctest --count --select=E9,F63,F7,F82 --show-source --statistics
+flake8 ./src/xdoctest --count --select=E9,F63,F7,F82 --show-source --statistics
diff --git a/run_tests.py b/run_tests.py
index b9657c4f..592caeb5 100755
--- a/run_tests.py
+++ b/run_tests.py
@@ -3,7 +3,7 @@
     import pytest
     import sys
     package_name = 'xdoctest'
-    mod_dpath = package_name
+    mod_dpath = './src/' + package_name
     test_dpath = 'tests'
     pytest_args = [
         '-p', 'pytester',
diff --git a/setup.py b/setup.py
index f063cad3..1cd2073f 100755
--- a/setup.py
+++ b/setup.py
@@ -7,13 +7,14 @@
 from setuptools import setup
 import sys
 from os.path import exists
+from setuptools import find_packages
 
 
 def parse_version(fpath):
     """
     Statically parse the version number from a python file
     """
-    value = static_parse("__version__", fpath)
+    value = static_parse('__version__', fpath)
     return value
 
 
@@ -24,15 +25,15 @@ def static_parse(varname, fpath):
     import ast
 
     if not exists(fpath):
-        raise ValueError("fpath={!r} does not exist".format(fpath))
-    with open(fpath, "r") as file_:
+        raise ValueError('fpath={!r} does not exist'.format(fpath))
+    with open(fpath, 'r') as file_:
         sourcecode = file_.read()
     pt = ast.parse(sourcecode)
 
     class StaticVisitor(ast.NodeVisitor):
         def visit_Assign(self, node):
             for target in node.targets:
-                if getattr(target, "id", None) == varname:
+                if getattr(target, 'id', None) == varname:
                     self.static_value = node.value.s
 
     visitor = StaticVisitor()
@@ -42,7 +43,7 @@ def visit_Assign(self, node):
     except AttributeError:
         import warnings
 
-        value = "Unknown {}".format(varname)
+        value = 'Unknown {}'.format(varname)
         warnings.warn(value)
     return value
 
@@ -57,16 +58,16 @@ def parse_description():
     """
     from os.path import dirname, join, exists
 
-    readme_fpath = join(dirname(__file__), "README.rst")
+    readme_fpath = join(dirname(__file__), 'README.rst')
     # This breaks on pip install, so check that it exists.
     if exists(readme_fpath):
-        with open(readme_fpath, "r") as f:
+        with open(readme_fpath, 'r') as f:
             text = f.read()
         return text
-    return ""
+    return ''
 
 
-def parse_requirements(fname="requirements.txt", versions=False):
+def parse_requirements(fname='requirements.txt', versions=False):
     """
     Parse the package dependencies listed in a requirements file but strips
     specific versioning information.
@@ -85,7 +86,7 @@ def parse_requirements(fname="requirements.txt", versions=False):
 
     require_fpath = fname
 
-    def parse_line(line, dpath=""):
+    def parse_line(line, dpath=''):
         """
         Parse information from a line in a requirements text file
 
@@ -93,72 +94,72 @@ def parse_line(line, dpath=""):
         line = '-e git+https://a.com/somedep@sometag#egg=SomeDep'
         """
         # Remove inline comments
-        comment_pos = line.find(" #")
+        comment_pos = line.find(' #')
         if comment_pos > -1:
             line = line[:comment_pos]
 
-        if line.startswith("-r "):
+        if line.startswith('-r '):
             # Allow specifying requirements in other files
-            target = join(dpath, line.split(" ")[1])
+            target = join(dpath, line.split(' ')[1])
             for info in parse_require_file(target):
                 yield info
         else:
             # See: https://www.python.org/dev/peps/pep-0508/
-            info = {"line": line}
-            if line.startswith("-e "):
-                info["package"] = line.split("#egg=")[1]
+            info = {'line': line}
+            if line.startswith('-e '):
+                info['package'] = line.split('#egg=')[1]
             else:
-                if ";" in line:
-                    pkgpart, platpart = line.split(";")
+                if ';' in line:
+                    pkgpart, platpart = line.split(';')
                     # Handle platform specific dependencies
                     # setuptools.readthedocs.io/en/latest/setuptools.html
                     # #declaring-platform-specific-dependencies
                     plat_deps = platpart.strip()
-                    info["platform_deps"] = plat_deps
+                    info['platform_deps'] = plat_deps
                 else:
                     pkgpart = line
                     platpart = None
 
                 # Remove versioning from the package
-                pat = "(" + "|".join([">=", "==", ">"]) + ")"
+                pat = '(' + '|'.join(['>=', '==', '>']) + ')'
                 parts = re.split(pat, pkgpart, maxsplit=1)
                 parts = [p.strip() for p in parts]
 
-                info["package"] = parts[0]
+                info['package'] = parts[0]
                 if len(parts) > 1:
                     op, rest = parts[1:]
                     version = rest  # NOQA
-                    info["version"] = (op, version)
+                    info['version'] = (op, version)
             yield info
 
     def parse_require_file(fpath):
         dpath = dirname(fpath)
-        with open(fpath, "r") as f:
+        with open(fpath, 'r') as f:
             for line in f.readlines():
                 line = line.strip()
-                if line and not line.startswith("#"):
+                if line and not line.startswith('#'):
                     for info in parse_line(line, dpath=dpath):
                         yield info
 
     def gen_packages_items():
         if exists(require_fpath):
             for info in parse_require_file(require_fpath):
-                parts = [info["package"]]
-                if versions and "version" in info:
-                    if versions == "strict":
+                parts = [info['package']]
+                if versions and 'version' in info:
+                    if versions == 'strict':
                         # In strict mode, we pin to the minimum version
-                        if info["version"]:
+                        if info['version']:
                             # Only replace the first >= instance
-                            verstr = "".join(info["version"]).replace(">=", "==", 1)
+                            verstr = ''.join(info['version']).replace('>=', '==', 1)
                             parts.append(verstr)
                     else:
-                        parts.extend(info["version"])
-                if not sys.version.startswith("3.4"):
+                        parts.extend(info['version'])
+                if not sys.version.startswith('3.4'):
                     # apparently package_deps are broken in 3.4
-                    plat_deps = info.get("platform_deps")
+                    plat_deps = info.get('platform_deps')
                     if plat_deps is not None:
-                        parts.append(";" + plat_deps)
-                item = "".join(parts)
+                        parts.append(';' + plat_deps)
+                item = ''.join(parts)
                 yield item
 
     packages = list(gen_packages_items())
@@ -166,31 +167,22 @@ def gen_packages_items():
 
 
 NAME = 'xdoctest'
-try:
-    VERSION = parse_version('xdoctest/__init__.py')
-except Exception:
-    raise
-    print('failed to parse values in setup.py')
-    VERSION = '???'
-
-
-from setuptools import find_packages  # NOQA
-
+VERSION = parse_version('src/xdoctest/__init__.py')
 
 if __name__ == '__main__':
     setupkw = {}
     setupkw['install_requires'] = parse_requirements('requirements/runtime.txt')
     setupkw['extras_require'] = {
-        "all": parse_requirements("requirements.txt"),
-        "tests": parse_requirements("requirements/tests.txt"),
-        "optional": parse_requirements("requirements/optional.txt"),
-        "all-strict": parse_requirements("requirements.txt", versions="strict"),
-        "runtime-strict": parse_requirements(
-            "requirements/runtime.txt", versions="strict"
+        'all': parse_requirements('requirements.txt'),
+        'tests': parse_requirements('requirements/tests.txt'),
+        'optional': parse_requirements('requirements/optional.txt'),
+        'all-strict': parse_requirements('requirements.txt', versions='strict'),
+        'runtime-strict': parse_requirements(
+            'requirements/runtime.txt', versions='strict'
         ),
-        "tests-strict": parse_requirements("requirements/tests.txt", versions="strict"),
-        "optional-strict": parse_requirements(
-            "requirements/optional.txt", versions="strict"
+        'tests-strict': parse_requirements('requirements/tests.txt', versions='strict'),
+        'optional-strict': parse_requirements(
+            'requirements/optional.txt', versions='strict'
         ),
         'colors': parse_requirements('requirements/colors.txt'),
         'jupyter': parse_requirements('requirements/jupyter.txt'),
@@ -205,7 +197,6 @@ def gen_packages_items():
     setupkw['long_description'] = parse_description()
     setupkw['long_description_content_type'] = 'text/x-rst'
     setupkw['license'] = 'Apache 2'
-    setupkw['packages'] = find_packages('.')
     setupkw['python_requires'] = '>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*'
     setupkw['classifiers'] = [
         'Development Status :: 5 - Production/Stable',
@@ -229,8 +220,16 @@ def gen_packages_items():
         'Programming Language :: Python :: Implementation :: PyPy',
         'Programming Language :: Python :: Implementation :: CPython',
     ]
+    # https://codefellows.github.io/sea-python-401d4/lectures/python_packaging_1.html
+    # We use a key of an empty string to indicate that the directory we are
+    # pointing to should be considered the root. Then the value is src, telling
+    # setuptools to use that directory as the root of our source.
     setupkw['package_dir'] = {
-        '': './src',
+        '': 'src',
+    }
+    setupkw['packages'] = find_packages('src')
+    setupkw['package_data'] = {
+        'xdoctest': ['py.typed', '*.pyi'],
     }
     setupkw['entry_points'] = {
         'console_scripts': [

From c69cd878c8fa402cabcb57db51b4850651ff0858 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 14:00:32 -0400
Subject: [PATCH 33/38] Fix issue

---
 .circleci/config.yml |  4 ++--
 docs/source/conf.py  |  2 +-
 pyproject.toml       | 40 ++++++++++++++++++++--------------------
 3 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/.circleci/config.yml b/.circleci/config.yml
index 3d18f16f..f122a40d 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -232,7 +232,7 @@ jobs:
   test_full/cp34-34m-linux:
     <<: *test_full_template
     docker:
-      - image: circleci/python:3.4
+      - image: cimg/python:3.4
 
   test_full/cp27-27mu-linux:
     <<: *test_full_template
@@ -273,7 +273,7 @@ jobs:
   test_minimal/cp34-34m-linux:
     <<: *test_minimal_template
     docker:
-      - image: circleci/python:3.4
+      - image: cimg/python:3.4
 
   test_minimal/cp27-27mu-linux:
     <<: *test_minimal_template
diff --git a/docs/source/conf.py b/docs/source/conf.py
index a9edb823..0e3f597e 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -84,7 +84,7 @@ def visit_Assign(self, node):
 # module = ub.import_module_from_path(modpath)
 # release = module.__version__
 
-modpath = join(dirname(dirname(dirname(__file__))), modname, '__init__.py')
+modpath = join(dirname(dirname(dirname(__file__))), 'src', modname, '__init__.py')
 # The full version, including alpha/beta/rc tags
 release = parse_version(modpath)
 version = '.'.join(release.split('.')[0:2])
diff --git a/pyproject.toml b/pyproject.toml
index 043d000d..0aa619f6 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -19,26 +19,26 @@ url = "https://github.com/Erotemic/xdoctest"
 license = "Apache 2"
 dev_status = "stable"
 classifiers = [
-    'Development Status :: 5 - Production/Stable',
-    'Intended Audience :: Developers',
-    'Topic :: Software Development :: Libraries :: Python Modules',
-    'Topic :: Utilities',
-    'Topic :: Software Development :: Testing',
-    'Framework :: Pytest',
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+    "Topic :: Software Development :: Testing",
+    "Framework :: Pytest",
     # This should be interpreted as Apache License v2.0
-    'License :: OSI Approved :: Apache Software License',
+    "License :: OSI Approved :: Apache Software License",
     # Supported Python versions
-    'Programming Language :: Python :: 3',
-    'Programming Language :: Python :: 3.10',
-    'Programming Language :: Python :: 3.9',
-    'Programming Language :: Python :: 3.8',
-    'Programming Language :: Python :: 3.7',
-    'Programming Language :: Python :: 3.6',
-    'Programming Language :: Python :: 3.5',
-    'Programming Language :: Python :: 3.4',
-    'Programming Language :: Python :: 2.7',
-    'Programming Language :: Python :: Implementation :: PyPy',
-    'Programming Language :: Python :: Implementation :: CPython',
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.5",
+    "Programming Language :: Python :: 3.4",
+    "Programming Language :: Python :: 2.7",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Programming Language :: Python :: Implementation :: CPython",
 ]
 
 [tool.xcookie.entry_points]
@@ -59,8 +59,8 @@ filterwarnings = [ "default", "ignore:.*No cfgstr given in Cacher constructor or
 
 [tool.coverage.run]
 branch = true
-source = ["xdoctest"]
+source = ["src/xdoctest"]
 
 [tool.coverage.report]
 exclude_lines = [ "pragma: no cover", ".*  # pragma: no cover", ".*  # nocover", "def __repr__", "raise AssertionError", "raise NotImplementedError", "if 0:", "if trace is not None", "verbose = .*", "^ *raise", "^ *pass *$", "if _debug:", "if __name__ == .__main__.:", ".*if six.PY2:",]
-omit = [ "xdoctest/__main__.py", "*/setup.py",]
+omit = [ "*/setup.py",]

From eb466842e1434d9bb66ef6577b1eb8c3832e2f10 Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 14:04:44 -0400
Subject: [PATCH 34/38] Remove 3.4 support

---
 .circleci/config.yml | 28 ++++++++++++++--------------
 setup.py             |  3 +--
 2 files changed, 15 insertions(+), 16 deletions(-)

diff --git a/.circleci/config.yml b/.circleci/config.yml
index f122a40d..7f938584 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -47,9 +47,9 @@ workflows:
       - test_full/cp35-35m-linux:
           filters:
               <<: *__ignore_release__
-      - test_full/cp34-34m-linux:
-          filters:
-              <<: *__ignore_release__
+      #- test_full/cp34-34m-linux:
+      #    filters:
+      #        <<: *__ignore_release__
       - test_full/cp27-27mu-linux:
           filters:
               <<: *__ignore_release__
@@ -72,9 +72,9 @@ workflows:
       - test_minimal/cp35-35m-linux:
           filters:
               <<: *__ignore_release__
-      - test_minimal/cp34-34m-linux:
-          filters:
-              <<: *__ignore_release__
+      #- test_minimal/cp34-34m-linux:
+      #    filters:
+      #        <<: *__ignore_release__
       - test_minimal/cp27-27mu-linux:
           filters:
               <<: *__ignore_release__
@@ -229,10 +229,10 @@ jobs:
     docker:
       - image: cimg/python:3.5
 
-  test_full/cp34-34m-linux:
-    <<: *test_full_template
-    docker:
-      - image: cimg/python:3.4
+  #test_full/cp34-34m-linux:
+  #  <<: *test_full_template
+  #  docker:
+  #    - image: circleci/python:3.4
 
   test_full/cp27-27mu-linux:
     <<: *test_full_template
@@ -270,10 +270,10 @@ jobs:
     docker:
       - image: cimg/python:3.5
 
-  test_minimal/cp34-34m-linux:
-    <<: *test_minimal_template
-    docker:
-      - image: cimg/python:3.4
+  #test_minimal/cp34-34m-linux:
+  #  <<: *test_minimal_template
+  #  docker:
+  #    - image: circleci/python:3.4
 
   test_minimal/cp27-27mu-linux:
     <<: *test_minimal_template
diff --git a/setup.py b/setup.py
index 1cd2073f..060651b4 100755
--- a/setup.py
+++ b/setup.py
@@ -197,7 +197,7 @@ def gen_packages_items():
     setupkw['long_description'] = parse_description()
     setupkw['long_description_content_type'] = 'text/x-rst'
     setupkw['license'] = 'Apache 2'
-    setupkw['python_requires'] = '>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*'
+    setupkw['python_requires'] = '>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4'
     setupkw['classifiers'] = [
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
@@ -215,7 +215,6 @@ def gen_packages_items():
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: Implementation :: PyPy',
         'Programming Language :: Python :: Implementation :: CPython',

From ffae36809e569bebee9ab932af1f2dfa770553ad Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 14:06:03 -0400
Subject: [PATCH 35/38] Fix RTD

---
 docs/source/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 0e3f597e..d7b321fb 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -127,7 +127,7 @@ def visit_Assign(self, node):
 }
 
 
-autoapi_dirs = [f'../../{modname}']
+autoapi_dirs = [f'../../src/{modname}']
 # autoapi_keep_files = True
 
 # Add any paths that contain templates here, relative to this directory.

From 66abd6ca80e2fce1c2dd7f4cd22f6c464bd64b3d Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 18:00:47 -0400
Subject: [PATCH 36/38] Bump coverage

---
 .coveragerc                         |  2 -
 .github/workflows/tests.yml         |  5 +-
 CHANGELOG.md                        |  3 ++
 clean.sh                            |  1 +
 dev/extension_proposal.py           | 82 +++++++++++++++++++++++++++++
 dev/parse_changelog.py              | 48 +++++++++++++++++
 pyproject.toml                      | 23 +++++++-
 requirements/optional.txt           |  3 ++
 src/xdoctest/__init__.py            | 46 ----------------
 src/xdoctest/__main__.py            | 47 ++++++++++-------
 src/xdoctest/checker.py             | 10 ++--
 src/xdoctest/constants.py           | 29 +++++++---
 src/xdoctest/core.py                | 34 +++++++-----
 src/xdoctest/plugin.py              |  4 +-
 src/xdoctest/runner.py              | 18 +++----
 src/xdoctest/static_analysis.py     | 30 -----------
 src/xdoctest/utils/util_notebook.py | 17 ++++++
 tests/test_doctest_example.py       |  2 +-
 tests/test_pytest_cli.py            | 53 +++++++++++++++++++
 tests/test_runner.py                | 59 +++++++++++++++++++++
 20 files changed, 377 insertions(+), 139 deletions(-)
 create mode 100644 dev/extension_proposal.py
 create mode 100644 dev/parse_changelog.py

diff --git a/.coveragerc b/.coveragerc
index a3dc8f4f..eb2db944 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -30,5 +30,3 @@ omit =
     xdoctest/__main__.py
     xdoctest/__init__.py
     xdoctest/exceptions.py
-    xdoctest/_old*.py
-    xdoctest/_grave*.py
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 3de69723..f6c2b98f 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -192,7 +192,8 @@ jobs:
         # Get the path to the installed package and run the tests
         MOD_DPATH=$(python -c "import xdoctest, os; print(os.path.dirname(xdoctest.__file__))")
         echo "MOD_DPATH = $MOD_DPATH"
-        python -m pytest -p pytester -p no:doctest --xdoctest --cov-config ../pyproject.toml --cov-report term --cov=xdoctest $MOD_DPATH ../tests
+        # https://pytest-cov.readthedocs.io/en/latest/plugins.html
+        COV_CORE_SOURCE="$MOD_DPATH" COV_CORE_CONFIG=../pyproject.toml COV_CORE_DATAFILE=.coverage.eager python -m pytest -p pytester -p no:doctest --xdoctest --cov-config ../pyproject.toml --cov-report html --cov-report term --cov-append --cov=xdoctest $MOD_DPATH ../tests
         # Move coverage file to a new name
         mv .coverage "../.coverage.$WORKSPACE_DNAME"
         cd ..
@@ -334,4 +335,4 @@ jobs:
 #        --secret=EROTEMIC_TWINE_USERNAME=$EROTEMIC_TWINE_USERNAME \
 #        --secret=EROTEMIC_CI_SECRET=$EROTEMIC_CI_SECRET \
 #        --secret=EROTEMIC_TEST_TWINE_USERNAME=$EROTEMIC_TEST_TWINE_USERNAME \
-#        --secret=EROTEMIC_TEST_TWINE_PASSWORD=$EROTEMIC_TEST_TWINE_PASSWORD
\ No newline at end of file
+#        --secret=EROTEMIC_TEST_TWINE_PASSWORD=$EROTEMIC_TEST_TWINE_PASSWORD
diff --git a/CHANGELOG.md b/CHANGELOG.md
index aa1b06d7..7a38a5f3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,10 +8,13 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Added
 * Add type stubs
+* Basic support for pyproject.toml under `tool.xdoctest`. Currently only
+  supports options in the native runner.
 
 ### Fixed
 * Corner case bug in error reporting
 * Doctests that never run any code are now correctly marked as skipped 
+* Issue where the "dumps" command was undocumented and has an error.
 
 ### Changed
 * Moved some globals into a new module called `global_state` and allowed
diff --git a/clean.sh b/clean.sh
index 99d3f177..a65e6cb0 100755
--- a/clean.sh
+++ b/clean.sh
@@ -5,6 +5,7 @@ rm -rf _skbuild
 rm -rf -- *.so
 rm -rf build
 rm -rf xdoctest.egg-info
+rm -rf src/xdoctest.egg-info
 rm -rf dist
 rm -rf docs/build
 rm -rf mb_work
diff --git a/dev/extension_proposal.py b/dev/extension_proposal.py
new file mode 100644
index 00000000..e6c3ffc2
--- /dev/null
+++ b/dev/extension_proposal.py
@@ -0,0 +1,82 @@
+"""
+I'm thinking about extending #xdoctest. My thought is that lack of docstring syntax highlighting and the mandatory >>> are the greatest barriers to entry. Editors must address the former, but xdoctest could address the later.
+
+Currently a google-style doctest looks like this
+
+Example:
+    >>> nums = [104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]
+    >>> chrs = list(map(chr, nums))
+    >>> text = ''.join(chrs)
+    >>> assert len(text) == 11, 'I like asserts better than got/want checks'
+    >>> print(text)
+    hello world
+
+But perhaps it could look like this
+
+Example:
+    nums = [104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]
+    chrs = list(map(chr, nums))
+    text = ''.join(chrs)
+    assert len(text) == 11, 'I like asserts better than got/want checks'
+    print(text)
+
+    hello world
+
+I see two disadvantages.
+
+First, even the editors that do support doctest highlights wont support this new
+style off the bat, but it does make the darn things a lot eaiser to type and
+work with without special editor extensions (like the ones I use in vimtk).
+
+Second, it is hard to distinguish code inputs from expected got/want output,
+and it also must exist in the context of a google-style example block.
+
+The second case might be addressed by a less intrusive header.
+We could do something IPython-like.
+
+
+Example:
+
+    In [1]:
+        nums = [104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]
+        chrs = list(map(chr, nums))
+        text = ''.join(chrs)
+        assert len(text) == 11, 'I like asserts better than got/want checks'
+        print(text)
+
+    Out [1]:
+        hello world
+
+
+But I don't like the additional indentation (and I think if there is a trailing
+`:`, you really ought to have indentation) , and the numbering might get
+annoying. Maybe break it into two google-docstr-style blocks?
+
+
+Example In[]:
+    nums = [104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]
+    chrs = list(map(chr, nums))
+    text = ''.join(chrs)
+    assert len(text) == 11, 'I like asserts better than got/want checks'
+    print(text)
+
+Example Out[]:
+    hello world
+
+
+As an additional extension we could do something to support an RST-style
+doctest header.
+
+.. code:: python
+
+    nums = [104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]
+    chrs = list(map(chr, nums))
+    text = ''.join(chrs)
+    assert len(text) == 11, 'I like asserts better than got/want checks'
+    print(text)
+
+    hello world
+
+Again, the problem of distinguishing inputs / outputs persists.
+
+"""
diff --git a/dev/parse_changelog.py b/dev/parse_changelog.py
new file mode 100644
index 00000000..f8718ad7
--- /dev/null
+++ b/dev/parse_changelog.py
@@ -0,0 +1,48 @@
+def _parse_changelog(fpath):
+    """
+    Helper to parse the changelog for the version to verify versions agree.
+
+    CommandLine:
+        xdoctest -m dev/parse_changelog.py _parse_changelog --dev
+    """
+    try:
+        from packaging.version import parse as LooseVersion
+    except ImportError:
+        from distutils.version import LooseVersion
+    import re
+    pat = re.compile(r'#.*Version ([0-9]+\.[0-9]+\.[0-9]+)')
+    # We can statically modify this to a constant value when we deploy
+    versions = []
+    with open(fpath, 'r') as file:
+        for line in file.readlines():
+            line = line.rstrip()
+            if line:
+                parsed = pat.search(line)
+                if parsed:
+                    print('parsed = {!r}'.format(parsed))
+                    try:
+                        version_text = parsed.groups()[0]
+                        version = LooseVersion(version_text)
+                        versions.append(version)
+                    except Exception:
+                        print('Failed to parse = {!r}'.format(line))
+
+    import pprint
+    print('versions = {}'.format(pprint.pformat(versions)))
+    assert sorted(versions)[::-1] == versions
+
+    import xdoctest
+    changelog_version = versions[0]
+    module_version = LooseVersion(xdoctest.__version__)
+    print('changelog_version = {!r}'.format(changelog_version))
+    print('module_version = {!r}'.format(module_version))
+    assert changelog_version == module_version
+
+
+if __name__ == '__main__':
+    """
+    CommandLine:
+        python ~/code/xdoctest/dev/parse_changelog.py
+    """
+    fpath = 'CHANGELOG.md'
+    _parse_changelog(fpath)
diff --git a/pyproject.toml b/pyproject.toml
index 0aa619f6..daa49117 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -62,5 +62,24 @@ branch = true
 source = ["src/xdoctest"]
 
 [tool.coverage.report]
-exclude_lines = [ "pragma: no cover", ".*  # pragma: no cover", ".*  # nocover", "def __repr__", "raise AssertionError", "raise NotImplementedError", "if 0:", "if trace is not None", "verbose = .*", "^ *raise", "^ *pass *$", "if _debug:", "if __name__ == .__main__.:", ".*if six.PY2:",]
-omit = [ "*/setup.py",]
+exclude_lines = [ 
+    "pragma: no cover",
+     ".*  # pragma: no cover",
+     ".*  # nocover",
+     "def __repr__",
+     "raise AssertionError",
+     "raise NotImplementedError",
+     "if 0:",
+     "if trace is not None",
+     "verbose = .*",
+     "^ *raise",
+     "^ *pass *$",
+     "if _debug:",
+     "if __name__ == .__main__.:", ".*if six.PY2:",
+]
+omit = [
+    "*/setup.py",
+]
+
+[tool.xdoctest]
+options = ''
diff --git a/requirements/optional.txt b/requirements/optional.txt
index 95b77471..e7e68b55 100644
--- a/requirements/optional.txt
+++ b/requirements/optional.txt
@@ -1,2 +1,5 @@
 -r colors.txt
 -r jupyter.txt
+
+# python  ~/local/tools/supported_python_versions_pip.py tomli
+tomli>=0.2.0  ; python_version < '3.11.0' and python_version >= '3.6'    # Python 3.6+
diff --git a/src/xdoctest/__init__.py b/src/xdoctest/__init__.py
index 3395aeb9..3314fd61 100644
--- a/src/xdoctest/__init__.py
+++ b/src/xdoctest/__init__.py
@@ -330,52 +330,6 @@ def fib(n):
 from xdoctest.exceptions import (DoctestParseError, ExitTestException,
                                  MalformedDocstr,)
 
-
-def _parse_changelog(fpath):
-    """
-    Helper to parse the changelog for the version to verify versions agree.
-
-    CommandLine:
-        xdoctest -m xdoctest.__init__ _parse_changelog --dev
-
-    Example:
-        >>> # xdoctest: +REQUIRES(--dev)
-        >>> fpath = 'CHANGELOG.md'
-        >>> _parse_changelog(fpath)
-    """
-    try:
-        from packaging.version import parse as LooseVersion
-    except ImportError:
-        from distutils.version import LooseVersion
-    import re
-    pat = re.compile(r'#.*Version ([0-9]+\.[0-9]+\.[0-9]+)')
-    # We can statically modify this to a constant value when we deploy
-    versions = []
-    with open(fpath, 'r') as file:
-        for line in file.readlines():
-            line = line.rstrip()
-            if line:
-                parsed = pat.search(line)
-                if parsed:
-                    print('parsed = {!r}'.format(parsed))
-                    try:
-                        version_text = parsed.groups()[0]
-                        version = LooseVersion(version_text)
-                        versions.append(version)
-                    except Exception:
-                        print('Failed to parse = {!r}'.format(line))
-
-    import pprint
-    print('versions = {}'.format(pprint.pformat(versions)))
-    assert sorted(versions)[::-1] == versions
-
-    import xdoctest
-    changelog_version = versions[0]
-    module_version = LooseVersion(xdoctest.__version__)
-    print('changelog_version = {!r}'.format(changelog_version))
-    print('module_version = {!r}'.format(module_version))
-    assert changelog_version == module_version
-
 __all__ = ['DoctestParseError', 'ExitTestException', 'MalformedDocstr',
            'doctest_module', 'doctest_callable', 'utils', 'docstr',
            '__version__']
diff --git a/src/xdoctest/__main__.py b/src/xdoctest/__main__.py
index a6e11ae2..50836673 100644
--- a/src/xdoctest/__main__.py
+++ b/src/xdoctest/__main__.py
@@ -25,10 +25,7 @@ def main(argv=None):
     Args:
         argv (List[str] | None):
     """
-    import argparse
     import xdoctest
-    from os.path import exists
-    from xdoctest import utils
 
     if argv is None:
         argv = sys.argv
@@ -47,6 +44,11 @@ def main(argv=None):
             print('{} = {}'.format(key, value))
         return 0
 
+    import argparse
+    import textwrap
+    from xdoctest import utils
+    from os.path import exists
+
     # FIXME: default values are reporting incorrectly or are missformated
     class RawDescriptionDefaultsHelpFormatter(
             argparse.RawDescriptionHelpFormatter,
@@ -61,12 +63,15 @@ class RawDescriptionDefaultsHelpFormatter(
         ).format(**version_info),
         formatter_class=RawDescriptionDefaultsHelpFormatter,
     )
+
+    # Ignored if optional arguments are specified, otherwise:
+    # Defaults --modname to arg.pop(0).
+    # Defaults --command to arg.pop(0).
     parser.add_argument(
         'arg', nargs='*', help=utils.codeblock(
             '''
-            Ignored if optional arguments are specified, otherwise:
-            Defaults --modname to arg.pop(0).
-            Defaults --command to arg.pop(0).
+            If the `--command` key / value pair is unspecified, the first
+            positional argument is used as the command.
             '''))
     parser.add_argument('--version', action='store_true', help='Display version info and quit')
 
@@ -79,10 +84,6 @@ class RawDescriptionDefaultsHelpFormatter(
     args, unknown = parser.parse_known_args(args=argv[1:])
     ns = args.__dict__.copy()
 
-    __DEBUG__ = '--debug' in sys.argv
-    if __DEBUG__:
-        print('ns = {!r}'.format(ns))
-
     if ns['version']:
         print(xdoctest.__version__)
         return 0
@@ -125,6 +126,22 @@ class RawDescriptionDefaultsHelpFormatter(
     options = ns['options']
     if options is None:
         options = ''
+        pyproject_fpath = 'pyproject.toml'
+        if exists(pyproject_fpath):
+            try:
+                import tomllib
+            except ImportError:
+                try:
+                    import tomli as tomllib
+                except ImportError:
+                    pass
+            else:
+                with open(pyproject_fpath, 'rb') as file:
+                    pyproject_settings = tomllib.load(file)
+                try:
+                    options = pyproject_settings['tool']['xdoctest']['options']
+                except KeyError:
+                    pass
         if exists('pytest.ini'):
             from six.moves import configparser
             parser = configparser.ConfigParser()
@@ -138,7 +155,6 @@ class RawDescriptionDefaultsHelpFormatter(
     from xdoctest import doctest_example
     config = doctest_example.DoctestConfig()._populate_from_cli(ns)
 
-    import textwrap
     if config['verbose'] > 2:
         print(textwrap.dedent(
             r'''
@@ -150,15 +166,6 @@ class RawDescriptionDefaultsHelpFormatter(
             =====================================
             '''))
 
-    if __DEBUG__:
-        try:
-            import ubelt as ub
-            print('config = {}'.format(ub.repr2(config)))
-            print('ns = {}'.format(ub.repr2(ns)))
-        except ImportError:
-            pass
-        print('modname = {!r}'.format(modname))
-
     run_summary = xdoctest.doctest_module(modname, argv=[command], style=style,
                                           verbose=config['verbose'],
                                           config=config, durations=durations,
diff --git a/src/xdoctest/checker.py b/src/xdoctest/checker.py
index e7f58e2c..c3dc369d 100644
--- a/src/xdoctest/checker.py
+++ b/src/xdoctest/checker.py
@@ -38,13 +38,13 @@
 from xdoctest import constants
 from xdoctest import directive
 
-unicode_literal_re = re.compile(r"(\W|^)[uU]([rR]?[\'\"])", re.UNICODE)  # nocover
-bytes_literal_re = re.compile(r"(\W|^)[bB]([rR]?[\'\"])", re.UNICODE)  # nocover
+unicode_literal_re = re.compile(r"(\W|^)[uU]([rR]?[\'\"])", re.UNICODE)
+bytes_literal_re = re.compile(r"(\W|^)[bB]([rR]?[\'\"])", re.UNICODE)
 
-BLANKLINE_MARKER = '<BLANKLINE>'  # nocover
-ELLIPSIS_MARKER = '...'  # nocover
+BLANKLINE_MARKER = '<BLANKLINE>'
+ELLIPSIS_MARKER = '...'
 
-TRAILING_WS = re.compile(r"[ \t]*$", re.UNICODE | re.MULTILINE)  # nocover
+TRAILING_WS = re.compile(r"[ \t]*$", re.UNICODE | re.MULTILINE)
 
 
 _EXCEPTION_RE = re.compile(r"""
diff --git a/src/xdoctest/constants.py b/src/xdoctest/constants.py
index c5e19d2e..7af38e69 100644
--- a/src/xdoctest/constants.py
+++ b/src/xdoctest/constants.py
@@ -4,14 +4,29 @@
 """
 from __future__ import print_function, division, absolute_import, unicode_literals
 
-# if False:
-#     NOT_EVALED = object()  # nocover
-# else:
-
 
 # Create the most singleton object ever to avoid reload issues
-# see ubelt.NoParam for details on how this works
+# this is based on ubelt.NoParam, which has more docs on how this works
 class _NOT_EVAL_TYPE(object):
+    """
+    This is a singleton object used as a sentinel value.  The value of
+    :data:`NoParam` is robust to reloading, pickling, and copying.  See
+    [SO_41048643]_ for more details.
+
+    References:
+        .. [SO_41048643]: http://stackoverflow.com/questions/41048643/a-second-none
+
+    Example:
+        >>> from xdoctest.constants import NOT_EVALED, _NOT_EVAL_TYPE  # NOQA
+        >>> import copy
+        >>> assert not NOT_EVALED
+        >>> assert str(NOT_EVALED) == '<NOT_EVALED>'
+        >>> assert repr(NOT_EVALED) == '<NOT_EVALED>'
+        >>> assert NOT_EVALED(...) is None
+        >>> assert copy.copy(NOT_EVALED) is NOT_EVALED
+        >>> assert copy.deepcopy(NOT_EVALED) is NOT_EVALED
+        >>> assert _NOT_EVAL_TYPE() is NOT_EVALED
+    """
     def __new__(cls):
         return NOT_EVALED
     def __reduce__(self):
@@ -31,5 +46,5 @@ def __bool__(self):
     __nonzero__ = __bool__
 try:
     NOT_EVALED  # type: ignore
-except NameError:  # pragma: no cover
-    NOT_EVALED = object.__new__(_NOT_EVAL_TYPE)  # pragma: no cover
+except NameError:
+    NOT_EVALED = object.__new__(_NOT_EVAL_TYPE)  # type: _NOT_EVAL_TYPE
diff --git a/src/xdoctest/core.py b/src/xdoctest/core.py
index 113f8637..7bb331c7 100644
--- a/src/xdoctest/core.py
+++ b/src/xdoctest/core.py
@@ -16,11 +16,19 @@
 * directives - special in-doctest comments that change the behavior of the
   doctests at runtime. See :mod:`xdoctest.directive` for more details.
 
-* the three cheverons (``>>> ``) - this is the standard prefix for a doctest,
-  also referred to as a PS1 line in the parser.
+* chevrons - the three cheverons (``>>> ``) or right angle brakets are the
+    standard prefix for a doctest, also referred to as a PS1 line in the
+    parser.
 
-* TODO - complete this list.
+* zero-args - a function that can be called without any arguments.
 
+* freeform style - This is the term used to refer to a doctest that could be
+    anywhere in the docstring. The alternative are structured doctests where
+    they are only expected in known positions like in "Example blocks" for
+    google and numpy style docstrings.
+
+* TODO - complete this list (Make an issue or PR if there is any term you don't
+    immediately understand!).
 """
 from __future__ import absolute_import, division, print_function, unicode_literals
 import sys
@@ -145,7 +153,7 @@ def doctest_from_parts(parts, num, curr_offset):
         example._parts = parts
         return example
 
-    if global_state.DEBUG_CORE:
+    if global_state.DEBUG_CORE:  # nocover
         print('Parsing docstring for callname={} in modpath={}'.format(
             callname, modpath))
 
@@ -290,7 +298,7 @@ def parse_auto_docstr_examples(docstr, *args, **kwargs):
     First try to parse google style, but if no tests are found use freeform
     style.
     """
-    if global_state.DEBUG_CORE:
+    if global_state.DEBUG_CORE:  # nocover
         print('Automatic style is trying google parsing')
 
     n_found = 0
@@ -304,7 +312,7 @@ def parse_auto_docstr_examples(docstr, *args, **kwargs):
 
     # no google style tests were found, parse in freeform
     if n_found == 0:
-        if global_state.DEBUG_CORE:
+        if global_state.DEBUG_CORE:  # nocover
             print('Automatic style is trying freeform parsing')
         for example in parse_freeform_docstr_examples(docstr, *args, **kwargs):
             yield example
@@ -361,7 +369,7 @@ def parse_docstr_examples(docstr, callname=None, modpath=None, lineno=1,
         1
         >>> examples = list(parse_docstr_examples(docstr, fpath='foo.txt'))
     """
-    if global_state.DEBUG_CORE:
+    if global_state.DEBUG_CORE:  # nocover
         print('Parsing docstring examples for '
               'callname={} in modpath={}'.format(callname, modpath))
     if style == 'freeform':
@@ -377,7 +385,7 @@ def parse_docstr_examples(docstr, callname=None, modpath=None, lineno=1,
         raise KeyError('Unknown style={}. Valid styles are {}'.format(
             style, DOCTEST_STYLES))
 
-    if global_state.DEBUG_CORE:
+    if global_state.DEBUG_CORE:  # nocover
         print('parser = {!r}'.format(parser))
 
     n_parsed = 0
@@ -387,7 +395,7 @@ def parse_docstr_examples(docstr, callname=None, modpath=None, lineno=1,
             n_parsed += 1
             yield example
     except Exception as ex:
-        if global_state.DEBUG_CORE:
+        if global_state.DEBUG_CORE:  # nocover
             print('Caught an error when parsing')
         msg = ('Cannot scrape callname={} in modpath={} line={}.\n'
                'Caused by: {}\n')
@@ -418,7 +426,7 @@ def parse_docstr_examples(docstr, callname=None, modpath=None, lineno=1,
             pass
         else:
             raise
-    if global_state.DEBUG_CORE:
+    if global_state.DEBUG_CORE:  # nocover
         print('Finished parsing {} examples'.format(n_parsed))
 
 
@@ -472,7 +480,7 @@ def package_calldefs(pkg_identifier, exclude=[], ignore_syntax_errors=True,
         >>> assert util_import.modpath_to_modname(modpath) == pkg_identifier
         >>> assert 'package_calldefs' in calldefs
     """
-    if global_state.DEBUG_CORE:
+    if global_state.DEBUG_CORE:  # nocover
         print('Find package calldefs: pkg_identifier = {!r}'.format(pkg_identifier))
 
     if isinstance(pkg_identifier, types.ModuleType):
@@ -573,7 +581,7 @@ def parse_calldefs(module_identifier, analysis='auto'):
     else:
         raise KeyError(analysis)
 
-    if global_state.DEBUG_CORE:
+    if global_state.DEBUG_CORE:  # nocover
         print('About to parse calldefs with do_dynamic={}'.format(do_dynamic))
 
     calldefs = None
@@ -593,7 +601,7 @@ def parse_calldefs(module_identifier, analysis='auto'):
     else:
         calldefs = static_analysis.parse_static_calldefs(fpath=module_identifier)
 
-    if global_state.DEBUG_CORE:
+    if global_state.DEBUG_CORE:  # nocover
         print('Found {} calldefs'.format(len(calldefs)))
 
     return calldefs
diff --git a/src/xdoctest/plugin.py b/src/xdoctest/plugin.py
index 319f097e..446e861a 100644
--- a/src/xdoctest/plugin.py
+++ b/src/xdoctest/plugin.py
@@ -23,7 +23,7 @@
 try:
     from packaging.version import parse as parse_version
     _PYTEST_IS_GE_620 = parse_version(pytest.__version__) >= parse_version('6.2.0')
-except ImportError:
+except ImportError:  # nocover
     from distutils.version import LooseVersion
     _PYTEST_IS_GE_620 = LooseVersion(pytest.__version__) >= LooseVersion('6.2.0')
 
@@ -115,7 +115,7 @@ def str_lower(x):
     )
 
 
-if pytest.__version__ < '7.':
+if pytest.__version__ < '7.':  # nocover
     def pytest_collect_file(path, parent):
         return _pytest_collect_file(path, parent, fspath=path)
 
diff --git a/src/xdoctest/runner.py b/src/xdoctest/runner.py
index 469b52f8..e63483e0 100644
--- a/src/xdoctest/runner.py
+++ b/src/xdoctest/runner.py
@@ -327,9 +327,9 @@ def _convert_to_test_module(enabled_examples):
         func_name = 'test_' + example.callname.replace('.', '_')
         body_lines = []
         for part in example._parts:
-            body_part = part.format_src(linenos=False, want=False,
-                                        prefix=False, colored=False,
-                                        partnos=False)
+            body_part = part.format_part(linenos=False, want=False,
+                                         prefix=False, colored=False,
+                                         partnos=False)
             if part.want:
                 want_text = '# doctest want:\n'
                 want_text += utils.indent(part.want, '# ')
@@ -569,17 +569,17 @@ def _parse_commandline(command=None, style='auto', verbose=None, argv=None):
 
 
 def _update_argparse_cli(add_argument, prefix=None):
-    def str_lower(x):
-        # python2 fix
-        return str.lower(str(x))
-
     add_argument(*('-m', '--modname'), type=str,
                  help='Module name or path. If specified positional modules are ignored',
                  default=None)
 
     add_argument(*('-c', '--command'), type=str,
-                 help='A doctest name or a command (list|all|<callname>). '
-                 'Defaults to all',
+                 help=(
+                     'A doctest name or a command (all|list|dump|<callname>). '
+                     'Defaults to `all` (which runs everything). Using `list` will '
+                     'collect and print all doctests. '
+                     'Using `dump` will convert doctests into unit tests. '
+                     'Anything else will be interpreted as a "callname"'),
                  default=None)
 
     add_argument(*('--style',), type=str,
diff --git a/src/xdoctest/static_analysis.py b/src/xdoctest/static_analysis.py
index e97fe594..3c38af8a 100644
--- a/src/xdoctest/static_analysis.py
+++ b/src/xdoctest/static_analysis.py
@@ -471,7 +471,6 @@ def _find_docstr_startpos_workaround(self, docstr, sourcelines, endpos):
             >>> # xdoctest: +REQUIRES(CPython)
             >>> # This function is a specific workaround for a CPython bug.
             >>> from xdoctest.static_analysis import *
-            >>> sys.DEBUG = '--debug' in sys.argv
             >>> sq = chr(39)  # single quote
             >>> dq = chr(34)  # double quote
             >>> source = utils.codeblock(
@@ -548,22 +547,12 @@ def func7():
             >>>         print('endpos = {!r}'.format(endpos))
             >>>         raise AssertionError('docstr workaround is failing')
             >>>     print('----------')
-            >>> sys.DEBUG = 0
         """
         # First assume a one-line string that starts and stops on the same line
         start = endpos
         stop = endpos + 1
         endline = sourcelines[stop - 1]
 
-        DEBUG = getattr(sys, 'DEBUG', 0)
-        if DEBUG:
-            print('----<<<')
-            #print('sourcelines = [{}]'.format('\n'.join(list(map(repr, sourcelines)))))
-            print('endpos = {!r}'.format(endpos))
-            print('start = {!r}'.format(start))
-            print('stop = {!r}'.format(stop))
-            print('endline = {!r}'.format(endline))
-
         # Determine if the docstring is a triple quoted string, by trying both
         # triple quote styles and checking if the string starts and ends with
         # the same style. If both cases are true we know we are in a triple
@@ -571,8 +560,6 @@ def func7():
         # line position.
         trips = ("'''", '"""')
         for trip in trips:
-            if DEBUG:
-                print('trip = {!r}'.format(trip))
             pattern = re.escape(trip) + r'\s*#.*$'
             # Assuming the multiline string is using `trip` as the triple quote
             # format, then the first instance of that pattern must terminate
@@ -588,12 +575,7 @@ def func7():
             # in the extracted docstring. This works because all newline
             # characters in multiline string literals MUST correspond to actual
             # newlines in the source code.
-            if DEBUG:
-                print('pattern = {!r}'.format(pattern))
-                print('endline_ = {!r}'.format(endline_))
             if endline_.endswith(trip):
-                if DEBUG:
-                    print('endline ended with trip')
                 nlines = docstr.count('\n')
                 # assuming that the docstr is actually terminated with this
                 # kind of triple quote, then the start line is at this position
@@ -604,23 +586,11 @@ def func7():
                 # Account for raw strings. Note f-strings cannot be docstrings
                 if startline.strip().startswith((trip, 'r' + trip)):
                     # Both conditions pass.
-                    if DEBUG:
-                        print('startline did end with trip')
                     start = cand_start_
                     break
                 else:
                     # Conditions failed, revert to assuming a one-line string.
-                    if DEBUG:
-                        print('startline did not end with trip')
                     start = stop - 1
-            else:
-                if DEBUG:
-                    print('endline did not end with trip')
-
-        if DEBUG:
-            print('start = {!r}'.format(start))
-            print('stop = {!r}'.format(stop))
-            print('----<<<')
         return start, stop
 
     def _get_docstring(self, node):
diff --git a/src/xdoctest/utils/util_notebook.py b/src/xdoctest/utils/util_notebook.py
index f6dd4aff..643cd454 100644
--- a/src/xdoctest/utils/util_notebook.py
+++ b/src/xdoctest/utils/util_notebook.py
@@ -45,6 +45,23 @@ def _find_notebook(fullname, path=None):
     This turns "foo.bar" into "foo/bar.ipynb"
     and tries turning "Foo_Bar" into "Foo Bar" if Foo_Bar
     does not exist.
+
+    Example:
+        >>> # xdoctest: +REQUIRES(PY3, module:IPython, module:nbconvert)
+        >>> from xdoctest.utils.util_notebook import _find_notebook
+        >>> from xdoctest import utils
+        >>> from os.path import join, basename, splitext
+        >>> self = utils.TempDir()
+        >>> dpath = self.ensure()
+        >>> fpath = join(dpath, 'test_import_notebook.ipynb')
+        >>> cells = ['x = 1']
+        >>> _make_test_notebook_fpath(fpath, cells)
+        >>> fullname = splitext(basename(fpath))[0]
+        >>> path = [dpath]
+        >>> _find_notebook(fullname, path)
+        .../test_import_notebook.ipynb
+        >>> _find_notebook(fullname, None)
+        None
     """
     name = fullname.rsplit('.', 1)[-1]
     if not path:
diff --git a/tests/test_doctest_example.py b/tests/test_doctest_example.py
index de67aa6e..cf245ca8 100644
--- a/tests/test_doctest_example.py
+++ b/tests/test_doctest_example.py
@@ -103,7 +103,7 @@ def test_failure():
     self._parse()
     try:
         self.run(on_error='raise')
-    except ZeroDivisionError as ex:
+    except ZeroDivisionError:
         pass
     else:
         raise AssertionError('should have gotten zero division')
diff --git a/tests/test_pytest_cli.py b/tests/test_pytest_cli.py
index 8fbff6ee..130e90fb 100644
--- a/tests/test_pytest_cli.py
+++ b/tests/test_pytest_cli.py
@@ -137,3 +137,56 @@ def test_this():
     info = cmd(sys.executable + ' -m pytest ' + temp_module.dpath)
     print(info['out'])
     assert info['ret'] != 0
+
+
+def test_version_and_cli_info():
+    """
+    """
+    import xdoctest
+    info = cmd(sys.executable + ' -m xdoctest --version')
+    assert info['out'].strip() == xdoctest.__version__
+
+    info = cmd(sys.executable + ' -m xdoctest --version-info')
+    assert xdoctest.__version__ in info['out']
+
+
+def test_simple_xdoctest_cli():
+    module_text = utils.codeblock(
+        '''
+        def module_func1():
+            """
+            This module has a doctest
+
+            Example:
+                >>> print('hello world')
+            """
+        ''')
+    temp_module = util_misc.TempModule(module_text)
+    modpath = temp_module.modpath
+    info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' --time')
+    assert 'time:' in info['out']
+
+    info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' all')
+    assert 'passed' in info['out']
+    info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' list')
+    assert 'passed' not in info['out']
+    info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' --verbose=0')
+    print(repr(info['out']))
+    assert info['out'].strip() == ''
+
+
+def test_simple_xdoctest_cli_errors():
+    module_text = utils.codeblock(
+        '''
+        def module_func1():
+            """
+            This module has a doctest
+
+            Example:
+                >>> raise Exception
+            """
+        ''')
+    temp_module = util_misc.TempModule(module_text)
+    modpath = temp_module.modpath
+    info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' --time')
+    assert '1 failed' in info['out']
diff --git a/tests/test_runner.py b/tests/test_runner.py
index 98f4a79c..70c754d7 100644
--- a/tests/test_runner.py
+++ b/tests/test_runner.py
@@ -140,6 +140,65 @@ def foo():
     assert 'i wanna see this' in cap.text
 
 
+def test_durations():
+    from xdoctest import runner
+    source = utils.codeblock(
+        '''
+        def func1():
+            """
+            Example:
+                >>> print(1)
+            """
+
+        def func2():
+            """
+            Example:
+                >>> print(123)
+            """
+        ''')
+    with utils.TempDir() as temp:
+        dpath = temp.dpath
+        modpath = join(dpath, 'test_durations.py')
+        with open(modpath, 'w') as file:
+            file.write(source)
+        with utils.CaptureStdout() as cap1:
+            runner.doctest_module(modpath, 'all', argv=[''], durations=10)
+        with utils.CaptureStdout() as cap2:
+            runner.doctest_module(modpath, 'all', argv=[''], durations=1)
+    assert cap1.text.count('time: ') == 2, '2 tests should have 2 durations'
+    assert cap2.text.count('time: ') == 1, 'should only have gotten 1 durration'
+
+
+def test_dump():
+    from xdoctest import runner
+    source = utils.codeblock(
+        '''
+        def func1():
+            """
+            Example:
+                >>> these = 'tests will be converted to unit tests'
+                >>> print(these + ' because sometimes you wanna')
+            """
+
+        def func2():
+            """
+            Example:
+                >>> for i in range(10):
+                >>>     these = 'and sometimes your doctests should have been '
+                >>> for j in range(10):
+                ...     print(these + ' unit tests all along')
+            """
+        ''')
+    with utils.TempDir() as temp:
+        dpath = temp.dpath
+        modpath = join(dpath, 'test_durations.py')
+        with open(modpath, 'w') as file:
+            file.write(source)
+        with utils.CaptureStdout() as cap:
+            runner.doctest_module(modpath, 'dump', argv=[''])
+    print(cap.text)
+
+
 def test_all_disabled():
     """
     pytest tests/test_runner.py::test_all_disabled -s -vv

From 192eae8d08b5db3eda015ecc481dd3444f49dfbe Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 18:36:17 -0400
Subject: [PATCH 37/38] py2

---
 .github/workflows/tests.yml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index f6c2b98f..5d6e91b7 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -193,7 +193,8 @@ jobs:
         MOD_DPATH=$(python -c "import xdoctest, os; print(os.path.dirname(xdoctest.__file__))")
         echo "MOD_DPATH = $MOD_DPATH"
         # https://pytest-cov.readthedocs.io/en/latest/plugins.html
-        COV_CORE_SOURCE="$MOD_DPATH" COV_CORE_CONFIG=../pyproject.toml COV_CORE_DATAFILE=.coverage.eager python -m pytest -p pytester -p no:doctest --xdoctest --cov-config ../pyproject.toml --cov-report html --cov-report term --cov-append --cov=xdoctest $MOD_DPATH ../tests
+        # python2 hack
+        COV_CORE_SOURCE="$MOD_DPATH" COV_CORE_CONFIG=../pyproject.toml COV_CORE_DATAFILE=.coverage.eager python -m pytest -p pytester -p no:doctest --xdoctest --cov-config ../pyproject.toml --cov-report html --cov-report term --cov-append --cov=xdoctest $MOD_DPATH ../tests || python -m pytest -p pytester -p no:doctest --xdoctest --cov-config ../pyproject.toml --cov-report term --cov=xdoctest $MOD_DPATH ../tests
         # Move coverage file to a new name
         mv .coverage "../.coverage.$WORKSPACE_DNAME"
         cd ..

From bde959400392c83dc5da8df9f0b543633908fa7c Mon Sep 17 00:00:00 2001
From: joncrall <erotemic@gmail.com>
Date: Sun, 10 Jul 2022 18:48:24 -0400
Subject: [PATCH 38/38] Fix win32 test

---
 src/xdoctest/utils/util_notebook.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/xdoctest/utils/util_notebook.py b/src/xdoctest/utils/util_notebook.py
index 643cd454..5bb78c0b 100644
--- a/src/xdoctest/utils/util_notebook.py
+++ b/src/xdoctest/utils/util_notebook.py
@@ -59,7 +59,7 @@ def _find_notebook(fullname, path=None):
         >>> fullname = splitext(basename(fpath))[0]
         >>> path = [dpath]
         >>> _find_notebook(fullname, path)
-        .../test_import_notebook.ipynb
+        ...test_import_notebook.ipynb
         >>> _find_notebook(fullname, None)
         None
     """