timerit 1.0.1__tar.gz → 1.2.0__tar.gz

timerit-1.2.0/MANIFEST.in

@@ -0,0 +1 @@
+include requirements/*.txt

{timerit-1.0.1 → timerit-1.2.0}/PKG-INFO

@@ -1,47 +1,64 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: timerit
-Version: 1.0.1
+Version: 1.2.0
 Summary: A powerful multiline alternative to timeit
-Home-page: https://github.com/Erotemic/timerit
-Author: Jon Crall
-Author-email: erotemic@gmail.com
-License: Apache 2
-Platform: UNKNOWN
+Author-email: Jon Crall <erotemic@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Erotemic/timerit
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.6
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
+License-File: LICENSE
 Provides-Extra: all
-Provides-Extra: all-strict
+Requires-Dist: pandas; extra == "all"
+Requires-Dist: kwplot; extra == "all"
+Provides-Extra: docs
+Requires-Dist: sphinx>=5.0.1; extra == "docs"
+Requires-Dist: sphinx-autobuild>=2021.3.14; extra == "docs"
+Requires-Dist: sphinx_rtd_theme>=1.0.0; extra == "docs"
+Requires-Dist: sphinxcontrib-napoleon>=0.7; extra == "docs"
+Requires-Dist: sphinx-autoapi>=1.8.4; extra == "docs"
+Requires-Dist: Pygments>=2.9.0; extra == "docs"
+Requires-Dist: myst_parser>=0.18.0; extra == "docs"
+Requires-Dist: sphinx-reredirects>=0.0.1; extra == "docs"
 Provides-Extra: optional
-Provides-Extra: optional-strict
-Provides-Extra: runtime-strict
+Requires-Dist: pandas; extra == "optional"
+Requires-Dist: kwplot; extra == "optional"
 Provides-Extra: tests
-Provides-Extra: tests-strict
-License-File: LICENSE
+Requires-Dist: xdoctest>=1.1.0; extra == "tests"
+Requires-Dist: pytest>=6.2.5; extra == "tests"
+Requires-Dist: pytest-cov>=3.0.0; extra == "tests"
+Dynamic: license-file
 
 
-|GithubActions| |Appveyor| |Codecov| |Pypi| |Downloads| |ReadTheDocs| 
+|GithubActions| |Appveyor| |Codecov| |Pypi| |Downloads| |ReadTheDocs|
 
-.. .. |CircleCI| 
 
 Timerit
 =======
 
-A powerful multiline alternative to Python's builtin ``timeit`` module.
+A powerful multiline alternative to Python's builtin `timeit <https://docs.python.org/3/library/timeit.html>`_ module.
 
 Docs are published at https://timerit.readthedocs.io/en/latest/ but this README
 and code comments contain a walkthrough.
 
++---------------+--------------------------------------------+
+| Github        | https://github.com/Erotemic/timerit        |
++---------------+--------------------------------------------+
+| Pypi          | https://pypi.org/project/timerit           |
++---------------+--------------------------------------------+
+| ReadTheDocs   | https://timerit.readthedocs.io/en/latest/  |
++---------------+--------------------------------------------+
+
 Description
 -----------
 
@@ -52,36 +69,110 @@ convert to a single line.
 Installation
 ------------
 
-::
+.. code:: bash
 
     pip install timerit
 
 
-Examples
---------
+Interactive Use
+---------------
 
-The quick and dirty way just requires one indent.
+The ``timerit`` library provides a succinct API for interactive use:
 
 .. code:: python
 
-    >>> import math
-    >>> from timerit import Timerit
-    >>> for _ in Timerit(num=200, verbose=2):
-    >>>     math.factorial(10000)
-    Timing for 200 loops
-    Timed for: 200 loops, best of 3
-        time per loop: best=2.469 ms, mean=2.49 ± 0.037 ms
+    >>> import timerit
+    >>> for _ in timerit:
+    ...     sum(range(100000))
+    Timed for: 288 loops, best of 5
+        time per loop: best=616.740 µs, mean=668.933 ± 124.2 µs
+
+Compare to ``timeit``:
+
+.. code:: bash
+
+    $ python -m timeit 'sum(range(100000))'
+    500 loops, best of 5: 721 usec per loop
+
+By default, any code within the loop will be repeatedly executed until at least
+200 ms have elapsed.  The timing results are then printed out.
+
+Here's what each of the numbers means:
 
-Use the loop variable as a context manager for more accurate timings or
-to incorporate a setup phase that is not timed. You can also access
-properties of the ``Timerit`` class to programmatically use results.
+- "288 loops": The code in the loop was run 288 times before the time limit was
+  reached.
+
+- "best of 5": Consider only the fastest of every 5 measured times, when
+  calculating the mean and standard deviation.  The reason for doing this is
+  that you can get slow times if the something in the background is consuming
+  resources, so you're generally only interested in the fastest times.  This
+  idea is also described in the
+  `timeit docs <https://docs.python.org/3/library/timeit.html#timeit.Timer.repeat>`_.
+
+- "best=616.740 µs": How long the fastest iteration took to run.  For the reasons
+  described above, this is usually the most consistent number, and the primary
+  number you should focus on.
+
+- "mean=668.933 ± 124.2 µs": The mean and the standard deviation of the "best of 5"
+  iterations.  This statistic is usually not as robust or useful as the fastest
+  time, but sometimes its helpful to know if there's high variance.
+
+The loop variable can be used as a context manager to only time a part of each
+loop (e.g. to make the timings more accurate, or to incorporate a setup phase
+that is not timed):
 
 .. code:: python
 
-    >>> import math
-    >>> from timerit import Timerit
-    >>> t1 = Timerit(num=200, verbose=2)
-    >>> for timer in t1:
+    >>> for timer in timerit:
+    ...     n = 100 * 1000
+    ...     with timer:
+    ...         sum(range(n))
+    Timed for: 318 loops, best of 5
+        time per loop: best=616.673 µs, mean=617.545 ± 0.9 µs
+
+It is also possible to provide arguments controlling how the timing
+measurements are made.  See the online documentation for more information on
+these arguments, but the snippet below runs for exactly 100 iterations, instead
+of however many fit in 200 ms.
+
+.. code:: python
+
+    >>> for _ in timerit(num=100):
+    ...     sum(range(100000))
+    Timed for: 100 loops, best of 5
+        time per loop: best=616.866 µs, mean=619.120 ± 5.3 µs
+
+
+Automatic Import
+~~~~~~~~~~~~~~~~
+If you want to make ``timerit`` even easier to use interactively, you can move
+the import to the PYTHONSTARTUP_ file.  If defined, this environment variable
+gives the path to a python script that will be executed just before every
+interactive session.  For example:
+
+.. code:: bash
+
+    $ export PYTHONSTARTUP=~/.pythonrc
+    $ cat $PYTHONSTARTUP
+    import timerit
+    $ python
+    >>> for _ in timerit:
+    ...     sum(range(100000))
+    ...
+    Timed for: 59 loops, best of 3
+        time per loop: best=2.532 ms, mean=3.309 ± 1.0 ms
+
+
+Programmatic Use
+----------------
+
+The timerit library also provides a ``Timerit`` class that can be used
+programmatically.
+
+.. code:: python
+
+    >>> import math, timerit
+    >>> for timer in timerit:
     >>>     setup_vars = 10000
     >>>     with timer:
     >>>         math.factorial(setup_vars)
@@ -91,7 +182,13 @@ properties of the ``Timerit`` class to programmatically use results.
         time per loop: best=2.064 ms, mean=2.115 ± 0.05 ms
     t1.total_time = 0.4427177629695507
 
-There is also a simple one-liner that is comparable to IPython magic:
+A common pattern is to create a single ``Timerit`` instance, then to repeatedly
+"reset" it with different labels to test a number of different algorithms.  The
+labels assigned in this way will be incorporated into the report strings that
+the ``Timerit`` instance produces.  The "Benchmark Recipe" below shows an example
+of this pattern.  So do all of the scripts in the ``examples/`` directory.
+
+There is also a simple one-liner that is comparable to ``timeit``'s IPython magic:
 
 Compare the timeit version:
 
@@ -108,7 +205,7 @@ With the Timerit version:
     Timed for: 1 loops, best of 1
         time per loop: best=4.828 µs, mean=4.828 ± 0.0 µs
 
-        
+
 How it works
 ------------
 
@@ -134,7 +231,7 @@ Using the with statement inside the loop is nice because you can run untimed
 setup code before you enter the context manager.
 
 In the case where no setup code is required, a more concise version of the
-synax is available. 
+syntax is available.
 
 .. code:: python
 
@@ -218,9 +315,19 @@ Benchmark Recipe
         # Your variables may change
         ax = kwplot.figure(fnum=1, doclf=True).gca()
         sns.lineplot(data=data, x='x', y='min', hue='method', marker='o', ax=ax)
-        ax.set_title('Benchmark')
-        ax.set_xlabel('A better x-variable description')
-        ax.set_ylabel('A better y-variable description')
+        ax.set_title('Benchmark Name')
+        ax.set_xlabel('x-variable description')
+        ax.set_ylabel('y-variable description')
+
+
+Related Work
+============
+
+* `timeit <https://docs.python.org/3/library/timeit.html>`_: The builtin timeit module for profiling single statements.
+
+* `line_profiler <https://github.com/pyutils/line_profiler>`_: Line-by-line profiling.
+
+* `ubelt <https://github.com/Erotemic/ubelt>`_: This library was original developed as a component of ubelt, but has since become a standalone module.
 
 
 .. |Travis| image:: https://img.shields.io/travis/Erotemic/timerit/master.svg?label=Travis%20CI
@@ -237,9 +344,10 @@ Benchmark Recipe
     :target: https://circleci.com/gh/Erotemic/timerit
 .. |ReadTheDocs| image:: https://readthedocs.org/projects/timerit/badge/?version=latest
     :target: http://timerit.readthedocs.io/en/latest/
-.. |CodeQuality| image:: https://api.codacy.com/project/badge/Grade/fdcedca723f24ec4be9c7067d91cb43b 
+.. |CodeQuality| image:: https://api.codacy.com/project/badge/Grade/fdcedca723f24ec4be9c7067d91cb43b
     :target: https://www.codacy.com/manual/Erotemic/timerit?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Erotemic/timerit&amp;utm_campaign=Badge_Grade
 .. |GithubActions| image:: https://github.com/Erotemic/timerit/actions/workflows/tests.yml/badge.svg?branch=main
     :target: https://github.com/Erotemic/timerit/actions?query=branch%3Amain
 
+.. _PYTHONSTARTUP: https://docs.python.org/3/using/cmdline.html?highlight=pythonstartup#envvar-PYTHONSTARTUP
 

timerit-1.0.1/timerit.egg-info/PKG-INFO → timerit-1.2.0/README.rst

@@ -1,47 +1,23 @@
-Metadata-Version: 2.1
-Name: timerit
-Version: 1.0.1
-Summary: A powerful multiline alternative to timeit
-Home-page: https://github.com/Erotemic/timerit
-Author: Jon Crall
-Author-email: erotemic@gmail.com
-License: Apache 2
-Platform: UNKNOWN
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.6
-Description-Content-Type: text/x-rst
-Provides-Extra: all
-Provides-Extra: all-strict
-Provides-Extra: optional
-Provides-Extra: optional-strict
-Provides-Extra: runtime-strict
-Provides-Extra: tests
-Provides-Extra: tests-strict
-License-File: LICENSE
-
-
-|GithubActions| |Appveyor| |Codecov| |Pypi| |Downloads| |ReadTheDocs| 
-
-.. .. |CircleCI| 
+
+|GithubActions| |Appveyor| |Codecov| |Pypi| |Downloads| |ReadTheDocs|
+
 
 Timerit
 =======
 
-A powerful multiline alternative to Python's builtin ``timeit`` module.
+A powerful multiline alternative to Python's builtin `timeit <https://docs.python.org/3/library/timeit.html>`_ module.
 
 Docs are published at https://timerit.readthedocs.io/en/latest/ but this README
 and code comments contain a walkthrough.
 
++---------------+--------------------------------------------+
+| Github        | https://github.com/Erotemic/timerit        |
++---------------+--------------------------------------------+
+| Pypi          | https://pypi.org/project/timerit           |
++---------------+--------------------------------------------+
+| ReadTheDocs   | https://timerit.readthedocs.io/en/latest/  |
++---------------+--------------------------------------------+
+
 Description
 -----------
 
@@ -52,36 +28,110 @@ convert to a single line.
 Installation
 ------------
 
-::
+.. code:: bash
 
     pip install timerit
 
 
-Examples
---------
+Interactive Use
+---------------
 
-The quick and dirty way just requires one indent.
+The ``timerit`` library provides a succinct API for interactive use:
 
 .. code:: python
 
-    >>> import math
-    >>> from timerit import Timerit
-    >>> for _ in Timerit(num=200, verbose=2):
-    >>>     math.factorial(10000)
-    Timing for 200 loops
-    Timed for: 200 loops, best of 3
-        time per loop: best=2.469 ms, mean=2.49 ± 0.037 ms
+    >>> import timerit
+    >>> for _ in timerit:
+    ...     sum(range(100000))
+    Timed for: 288 loops, best of 5
+        time per loop: best=616.740 µs, mean=668.933 ± 124.2 µs
+
+Compare to ``timeit``:
+
+.. code:: bash
 
-Use the loop variable as a context manager for more accurate timings or
-to incorporate a setup phase that is not timed. You can also access
-properties of the ``Timerit`` class to programmatically use results.
+    $ python -m timeit 'sum(range(100000))'
+    500 loops, best of 5: 721 usec per loop
+
+By default, any code within the loop will be repeatedly executed until at least
+200 ms have elapsed.  The timing results are then printed out.
+
+Here's what each of the numbers means:
+
+- "288 loops": The code in the loop was run 288 times before the time limit was
+  reached.
+
+- "best of 5": Consider only the fastest of every 5 measured times, when
+  calculating the mean and standard deviation.  The reason for doing this is
+  that you can get slow times if the something in the background is consuming
+  resources, so you're generally only interested in the fastest times.  This
+  idea is also described in the
+  `timeit docs <https://docs.python.org/3/library/timeit.html#timeit.Timer.repeat>`_.
+
+- "best=616.740 µs": How long the fastest iteration took to run.  For the reasons
+  described above, this is usually the most consistent number, and the primary
+  number you should focus on.
+
+- "mean=668.933 ± 124.2 µs": The mean and the standard deviation of the "best of 5"
+  iterations.  This statistic is usually not as robust or useful as the fastest
+  time, but sometimes its helpful to know if there's high variance.
+
+The loop variable can be used as a context manager to only time a part of each
+loop (e.g. to make the timings more accurate, or to incorporate a setup phase
+that is not timed):
 
 .. code:: python
 
-    >>> import math
-    >>> from timerit import Timerit
-    >>> t1 = Timerit(num=200, verbose=2)
-    >>> for timer in t1:
+    >>> for timer in timerit:
+    ...     n = 100 * 1000
+    ...     with timer:
+    ...         sum(range(n))
+    Timed for: 318 loops, best of 5
+        time per loop: best=616.673 µs, mean=617.545 ± 0.9 µs
+
+It is also possible to provide arguments controlling how the timing
+measurements are made.  See the online documentation for more information on
+these arguments, but the snippet below runs for exactly 100 iterations, instead
+of however many fit in 200 ms.
+
+.. code:: python
+
+    >>> for _ in timerit(num=100):
+    ...     sum(range(100000))
+    Timed for: 100 loops, best of 5
+        time per loop: best=616.866 µs, mean=619.120 ± 5.3 µs
+
+
+Automatic Import
+~~~~~~~~~~~~~~~~
+If you want to make ``timerit`` even easier to use interactively, you can move
+the import to the PYTHONSTARTUP_ file.  If defined, this environment variable
+gives the path to a python script that will be executed just before every
+interactive session.  For example:
+
+.. code:: bash
+
+    $ export PYTHONSTARTUP=~/.pythonrc
+    $ cat $PYTHONSTARTUP
+    import timerit
+    $ python
+    >>> for _ in timerit:
+    ...     sum(range(100000))
+    ...
+    Timed for: 59 loops, best of 3
+        time per loop: best=2.532 ms, mean=3.309 ± 1.0 ms
+
+
+Programmatic Use
+----------------
+
+The timerit library also provides a ``Timerit`` class that can be used
+programmatically.
+
+.. code:: python
+
+    >>> import math, timerit
+    >>> for timer in timerit:
     >>>     setup_vars = 10000
     >>>     with timer:
     >>>         math.factorial(setup_vars)
@@ -91,7 +141,13 @@ properties of the ``Timerit`` class to programmatically use results.
         time per loop: best=2.064 ms, mean=2.115 ± 0.05 ms
     t1.total_time = 0.4427177629695507
 
-There is also a simple one-liner that is comparable to IPython magic:
+A common pattern is to create a single ``Timerit`` instance, then to repeatedly
+"reset" it with different labels to test a number of different algorithms.  The
+labels assigned in this way will be incorporated into the report strings that
+the ``Timerit`` instance produces.  The "Benchmark Recipe" below shows an example
+of this pattern.  So do all of the scripts in the ``examples/`` directory.
+
+There is also a simple one-liner that is comparable to ``timeit``'s IPython magic:
 
 Compare the timeit version:
 
@@ -108,7 +164,7 @@ With the Timerit version:
     Timed for: 1 loops, best of 1
         time per loop: best=4.828 µs, mean=4.828 ± 0.0 µs
 
-        
+
 How it works
 ------------
 
@@ -134,7 +190,7 @@ Using the with statement inside the loop is nice because you can run untimed
 setup code before you enter the context manager.
 
 In the case where no setup code is required, a more concise version of the
-synax is available. 
+syntax is available.
 
 .. code:: python
 
@@ -218,9 +274,19 @@ Benchmark Recipe
         # Your variables may change
         ax = kwplot.figure(fnum=1, doclf=True).gca()
         sns.lineplot(data=data, x='x', y='min', hue='method', marker='o', ax=ax)
-        ax.set_title('Benchmark')
-        ax.set_xlabel('A better x-variable description')
-        ax.set_ylabel('A better y-variable description')
+        ax.set_title('Benchmark Name')
+        ax.set_xlabel('x-variable description')
+        ax.set_ylabel('y-variable description')
+
+
+Related Work
+============
+
+* `timeit <https://docs.python.org/3/library/timeit.html>`_: The builtin timeit module for profiling single statements.
+
+* `line_profiler <https://github.com/pyutils/line_profiler>`_: Line-by-line profiling.
+
+* `ubelt <https://github.com/Erotemic/ubelt>`_: This library was original developed as a component of ubelt, but has since become a standalone module.
 
 
 .. |Travis| image:: https://img.shields.io/travis/Erotemic/timerit/master.svg?label=Travis%20CI
@@ -237,9 +303,10 @@ Benchmark Recipe
     :target: https://circleci.com/gh/Erotemic/timerit
 .. |ReadTheDocs| image:: https://readthedocs.org/projects/timerit/badge/?version=latest
     :target: http://timerit.readthedocs.io/en/latest/
-.. |CodeQuality| image:: https://api.codacy.com/project/badge/Grade/fdcedca723f24ec4be9c7067d91cb43b 
+.. |CodeQuality| image:: https://api.codacy.com/project/badge/Grade/fdcedca723f24ec4be9c7067d91cb43b
     :target: https://www.codacy.com/manual/Erotemic/timerit?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Erotemic/timerit&amp;utm_campaign=Badge_Grade
 .. |GithubActions| image:: https://github.com/Erotemic/timerit/actions/workflows/tests.yml/badge.svg?branch=main
     :target: https://github.com/Erotemic/timerit/actions?query=branch%3Amain
 
+.. _PYTHONSTARTUP: https://docs.python.org/3/using/cmdline.html?highlight=pythonstartup#envvar-PYTHONSTARTUP
 

timerit-1.2.0/pyproject.toml

@@ -0,0 +1,135 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [
+  "setuptools>=41.0.1",
+  "setuptools>=77",
+]
+
+[project]
+name = "timerit"
+description = "A powerful multiline alternative to timeit"
+license = "Apache-2.0"
+license-files = [
+  "LICENSE",
+]
+authors = [ { name = "Jon Crall", email = "erotemic@gmail.com" } ]
+requires-python = ">=3.10"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Utilities",
+]
+dynamic = [
+  "dependencies",
+  "optional-dependencies",
+  "readme",
+  "version",
+]
+urls.Homepage = "https://github.com/Erotemic/timerit"
+
+[tool.setuptools]
+include-package-data = true
+dynamic.dependencies.file = [
+  "requirements/runtime.txt",
+]
+dynamic.optional-dependencies.all.file = [
+  "requirements/optional.txt",
+]
+dynamic.optional-dependencies.docs.file = [
+  "requirements/docs.txt",
+]
+dynamic.optional-dependencies.optional.file = [
+  "requirements/optional.txt",
+]
+dynamic.optional-dependencies.tests.file = [
+  "requirements/tests.txt",
+]
+dynamic.readme.file = [
+  "README.rst",
+]
+dynamic.readme.content-type = "text/x-rst"
+dynamic.version.attr = "timerit.__version__"
+package-data."*" = [
+  "requirements/*.txt",
+]
+package-data.timerit = [
+  "py.typed",
+]
+packages.find.where = [
+  ".",
+]
+packages.find.include = [
+  "timerit*",
+]
+
+[tool.mypy]
+ignore_missing_imports = true
+
+[tool.pytest]
+ini_options.addopts = "-p no:doctest --xdoctest --xdoctest-style=google --ignore-glob=setup.py --ignore-glob=dev --ignore-glob=docs"
+ini_options.norecursedirs = ".git ignore build __pycache__ dev _skbuild docs"
+ini_options.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
+report.exclude_lines = [
+  ".*  # nocover",
+  ".*  # pragma: no cover",
+  ".*if six.PY2:",
+  "^ *pass *$",
+  "^ *raise",
+  "def __repr__",
+  "if __name__ == .__main__.:",
+  "if _debug:",
+  "if 0:",
+  "if trace is not None",
+  "pragma: no cover",
+  "raise AssertionError",
+  "raise NotImplementedError",
+  "verbose = .*",
+]
+report.omit = [
+  "*/setup.py",
+  "timerit/__main__.py",
+]
+
+[tool.xcookie]
+tags = [
+  "erotemic",
+  "purepy",
+  "github",
+]
+mod_name = "timerit"
+repo_name = "timerit"
+rel_mod_parent_dpath = "."
+os = [
+  "linux",
+  "osx",
+  "win",
+]
+min_python = "3.10"
+version = "{mod_dpath}/__init__.py::__version__"
+url = "https://github.com/Erotemic/timerit"
+author = "Jon Crall"
+author_email = "erotemic@gmail.com"
+description = "A powerful multiline alternative to timeit"
+license = "Apache 2"
+dev_status = "stable"
+typed = true
+workspace_members = []
+workspace_sync_versions = false
+use_setup_py = false
+use_pyproject_requirements = false
+enable_gpg = true

timerit-1.2.0/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