Skip to content

Fixes for broken default install (optional graphs dependencies) #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JerilynFranz merged 6 commits into from
Dec 1, 2025
Merged

Fixes for broken default install (optional graphs dependencies) #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3d91385
Merge pull request #23 from JerilynFranz/main
JerilynFranz Dec 1, 2025
a0c3f70
Updated release in README.rst
JerilynFranz Dec 1, 2025
75264af
Merge branch 'Documentation-Updates' of https://github.com/JerilynFra…
JerilynFranz Dec 1, 2025
a95c72f
Updating pip install instructions
JerilynFranz Dec 1, 2025
7c2ed56
Fixes for breakage from optional install packages
JerilynFranz Dec 1, 2025
79d28f0
Regenerated docs for 0.6.1-alpha.0 release
JerilynFranz Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ SimpleBench

A framework for building and running benchmarks.

* 0.6.1-alpha.0 2025-12-1
* Fix for failed imports related to optional [graphs] dependencies in default install
* 0.6.0-alpha.0 2025-12-1
* Splitting of pypi install groups
* default - all reporters except graph reporters
Expand Down
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ As such it has the following goals:
Current Status
--------------

Alpha release 0.5.1-alpha.0
Alpha release 0.6.1-alpha.0

Functionally complete but not yet 100% tested or documented.
There may be breaking changes before reaching version 1.0.
Expand Down Expand Up @@ -50,7 +50,7 @@ Minimum Python Version: 3.10

git clone https://github.com/JerilynFranz/python-simplebench
cd python-simplebench
python3 -m pip install .
python3 -m pip install .[all]

Documentation
-------------
Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html">

<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 -->
<title>Overview: module code - simplebench 0.6.0-alpha.0 documentation</title>
<title>Overview: module code - simplebench 0.6.1-alpha.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=d998a142" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -163,7 +163,7 @@
</label>
</div>
<div class="header-center">
<a href="../index.html"><div class="brand">simplebench 0.6.0-alpha.0 documentation</div></a>
<a href="../index.html"><div class="brand">simplebench 0.6.1-alpha.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -184,7 +184,7 @@

<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">

<span class="sidebar-brand-text">simplebench 0.6.0-alpha.0 documentation</span>
<span class="sidebar-brand-text">simplebench 0.6.1-alpha.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -355,7 +355,7 @@ <h1>All modules for which code is available</h1>

</aside>
</div>
</div><script src="../_static/documentation_options.js?v=f104ce99"></script>
</div><script src="../_static/documentation_options.js?v=8c7f9c82"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.6.0-alpha.0',
VERSION: '0.6.1-alpha.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
8 changes: 4 additions & 4 deletions docs/command_line_options.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Reports" href="reports.html"><link rel="prev" title="Controlling Benchmark Execution" href="tutorials/controlling.html">

<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 -->
<title>Command-Line Options - simplebench 0.6.0-alpha.0 documentation</title>
<title>Command-Line Options - simplebench 0.6.1-alpha.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=d998a142" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -164,7 +164,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">simplebench 0.6.0-alpha.0 documentation</div></a>
<a href="index.html"><div class="brand">simplebench 0.6.1-alpha.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -185,7 +185,7 @@

<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">

<span class="sidebar-brand-text">simplebench 0.6.0-alpha.0 documentation</span>
<span class="sidebar-brand-text">simplebench 0.6.1-alpha.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -550,7 +550,7 @@ <h3>JSON Reports<a class="headerlink" href="#json-reports" title="Link to this h

</aside>
</div>
</div><script src="_static/documentation_options.js?v=f104ce99"></script>
</div><script src="_static/documentation_options.js?v=8c7f9c82"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
Expand Down
8 changes: 4 additions & 4 deletions docs/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#"><link rel="search" title="Search" href="search.html">

<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 --><title>Index - simplebench 0.6.0-alpha.0 documentation</title>
<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 --><title>Index - simplebench 0.6.1-alpha.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=d998a142" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -162,7 +162,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">simplebench 0.6.0-alpha.0 documentation</div></a>
<a href="index.html"><div class="brand">simplebench 0.6.1-alpha.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -183,7 +183,7 @@

<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">

<span class="sidebar-brand-text">simplebench 0.6.0-alpha.0 documentation</span>
<span class="sidebar-brand-text">simplebench 0.6.1-alpha.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -5106,7 +5106,7 @@ <h2>Y</h2>

</aside>
</div>
</div><script src="_static/documentation_options.js?v=f104ce99"></script>
</div><script src="_static/documentation_options.js?v=8c7f9c82"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
Expand Down
8 changes: 4 additions & 4 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Installation" href="installation.html">

<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 -->
<title>simplebench 0.6.0-alpha.0 documentation</title>
<title>simplebench 0.6.1-alpha.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=d998a142" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -164,7 +164,7 @@
</label>
</div>
<div class="header-center">
<a href="#"><div class="brand">simplebench 0.6.0-alpha.0 documentation</div></a>
<a href="#"><div class="brand">simplebench 0.6.1-alpha.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -185,7 +185,7 @@

<div class="sidebar-sticky"><a class="sidebar-brand" href="#">

<span class="sidebar-brand-text">simplebench 0.6.0-alpha.0 documentation</span>
<span class="sidebar-brand-text">simplebench 0.6.1-alpha.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -354,7 +354,7 @@ <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">

</aside>
</div>
</div><script src="_static/documentation_options.js?v=f104ce99"></script>
</div><script src="_static/documentation_options.js?v=8c7f9c82"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
Expand Down
8 changes: 4 additions & 4 deletions docs/installation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Using SimpleBench" href="usage.html"><link rel="prev" title="SimpleBench documentation" href="index.html">

<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 -->
<title>Installation - simplebench 0.6.0-alpha.0 documentation</title>
<title>Installation - simplebench 0.6.1-alpha.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=d998a142" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -164,7 +164,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">simplebench 0.6.0-alpha.0 documentation</div></a>
<a href="index.html"><div class="brand">simplebench 0.6.1-alpha.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -185,7 +185,7 @@

<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">

<span class="sidebar-brand-text">simplebench 0.6.0-alpha.0 documentation</span>
<span class="sidebar-brand-text">simplebench 0.6.1-alpha.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -362,7 +362,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Link to this h

</aside>
</div>
</div><script src="_static/documentation_options.js?v=f104ce99"></script>
</div><script src="_static/documentation_options.js?v=8c7f9c82"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
Expand Down
Binary file modified docs/objects.inv
View file
Open in desktop
Binary file not shown.
8 changes: 4 additions & 4 deletions docs/py-modindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html">

<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 --><title>Python Module Index - simplebench 0.6.0-alpha.0 documentation</title>
<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 --><title>Python Module Index - simplebench 0.6.1-alpha.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=d998a142" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -162,7 +162,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">simplebench 0.6.0-alpha.0 documentation</div></a>
<a href="index.html"><div class="brand">simplebench 0.6.1-alpha.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -183,7 +183,7 @@

<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">

<span class="sidebar-brand-text">simplebench 0.6.0-alpha.0 documentation</span>
<span class="sidebar-brand-text">simplebench 0.6.1-alpha.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -1191,7 +1191,7 @@ <h1>Python Module Index</h1>

</aside>
</div>
</div><script src="_static/documentation_options.js?v=f104ce99"></script>
</div><script src="_static/documentation_options.js?v=8c7f9c82"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
Expand Down
8 changes: 4 additions & 4 deletions docs/reports.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Rich Table Report" href="reports/rich_table_report.html"><link rel="prev" title="Command-Line Options" href="command_line_options.html">

<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 -->
<title>Reports - simplebench 0.6.0-alpha.0 documentation</title>
<title>Reports - simplebench 0.6.1-alpha.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=d998a142" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -164,7 +164,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">simplebench 0.6.0-alpha.0 documentation</div></a>
<a href="index.html"><div class="brand">simplebench 0.6.1-alpha.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -185,7 +185,7 @@

<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">

<span class="sidebar-brand-text">simplebench 0.6.0-alpha.0 documentation</span>
<span class="sidebar-brand-text">simplebench 0.6.1-alpha.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -337,7 +337,7 @@ <h1>Reports<a class="headerlink" href="#reports" title="Link to this heading">

</aside>
</div>
</div><script src="_static/documentation_options.js?v=f104ce99"></script>
</div><script src="_static/documentation_options.js?v=8c7f9c82"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
Expand Down
8 changes: 4 additions & 4 deletions docs/reports/csv_report.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html"><link rel="next" title="JSON Report" href="json_report.html"><link rel="prev" title="Rich Table Report" href="rich_table_report.html">

<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 -->
<title>CSV Report - simplebench 0.6.0-alpha.0 documentation</title>
<title>CSV Report - simplebench 0.6.1-alpha.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=d998a142" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -164,7 +164,7 @@
</label>
</div>
<div class="header-center">
<a href="../index.html"><div class="brand">simplebench 0.6.0-alpha.0 documentation</div></a>
<a href="../index.html"><div class="brand">simplebench 0.6.1-alpha.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -185,7 +185,7 @@

<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">

<span class="sidebar-brand-text">simplebench 0.6.0-alpha.0 documentation</span>
<span class="sidebar-brand-text">simplebench 0.6.1-alpha.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -462,7 +462,7 @@ <h3>Custom Complexity Weightings<a class="headerlink" href="#custom-complexity-w

</aside>
</div>
</div><script src="../_static/documentation_options.js?v=f104ce99"></script>
</div><script src="../_static/documentation_options.js?v=8c7f9c82"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
Expand Down
8 changes: 4 additions & 4 deletions docs/reports/csv_report_field_definitions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html">

<!-- Generated with Sphinx 8.1.3 and Furo 2025.09.25 -->
<title>CSV Field Definitions - simplebench 0.6.0-alpha.0 documentation</title>
<title>CSV Field Definitions - simplebench 0.6.1-alpha.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=d998a142" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -164,7 +164,7 @@
</label>
</div>
<div class="header-center">
<a href="../index.html"><div class="brand">simplebench 0.6.0-alpha.0 documentation</div></a>
<a href="../index.html"><div class="brand">simplebench 0.6.1-alpha.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -185,7 +185,7 @@

<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">

<span class="sidebar-brand-text">simplebench 0.6.0-alpha.0 documentation</span>
<span class="sidebar-brand-text">simplebench 0.6.1-alpha.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -537,7 +537,7 @@ <h2>Memory Usage<a class="headerlink" href="#memory-usage" title="Link to this h

</aside>
</div>
</div><script src="../_static/documentation_options.js?v=f104ce99"></script>
</div><script src="../_static/documentation_options.js?v=8c7f9c82"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
Expand Down
Loading