pytest-codspeed 3.0.0b3__tar.gz → 3.1.0__tar.gz

{pytest_codspeed-3.0.0b3 → pytest_codspeed-3.1.0}/PKG-INFO

@@ -1,10 +1,7 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.1
 Name: pytest-codspeed
-Version: 3.0.0b3
+Version: 3.1.0
 Summary: Pytest plugin to create CodSpeed benchmarks
-Project-URL: Homepage, https://codspeed.io/
-Project-URL: Documentation, https://docs.codspeed.io/
-Project-URL: Source, https://github.com/CodSpeedHQ/pytest-codspeed
 Author-email: Arthur Pastel <arthur@codspeed.io>
 License: The MIT License (MIT)
         
@@ -27,15 +24,17 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
         THE SOFTWARE.
-License-File: LICENSE
-Keywords: benchmark,codspeed,performance,pytest
+        
+Project-URL: Homepage, https://codspeed.io/
+Project-URL: Documentation, https://docs.codspeed.io/
+Project-URL: Source, https://github.com/CodSpeedHQ/pytest-codspeed
+Keywords: codspeed,benchmark,performance,pytest
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -45,32 +44,28 @@ Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: System :: Benchmark
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
 Requires-Dist: cffi>=1.17.1
-Requires-Dist: filelock>=3.12.2
-Requires-Dist: importlib-metadata>=8.5.0; python_version < '3.10'
 Requires-Dist: pytest>=3.8
 Requires-Dist: rich>=13.8.1
-Requires-Dist: setuptools; python_full_version >= '3.12.0'
-Provides-Extra: build
-Requires-Dist: semver>=3.0.2; extra == 'build'
-Provides-Extra: compat
-Requires-Dist: pytest-benchmark~=4.0.0; extra == 'compat'
-Requires-Dist: pytest-xdist~=3.6.1; extra == 'compat'
+Requires-Dist: importlib-metadata>=8.5.0; python_version < "3.10"
 Provides-Extra: lint
-Requires-Dist: mypy~=1.11.2; extra == 'lint'
-Requires-Dist: ruff~=0.6.5; extra == 'lint'
+Requires-Dist: mypy~=1.11.2; extra == "lint"
+Requires-Dist: ruff~=0.6.5; extra == "lint"
+Provides-Extra: compat
+Requires-Dist: pytest-benchmark~=5.0.0; extra == "compat"
+Requires-Dist: pytest-xdist~=3.6.1; extra == "compat"
 Provides-Extra: test
-Requires-Dist: pytest-cov~=4.0.0; extra == 'test'
-Requires-Dist: pytest~=7.0; extra == 'test'
-Description-Content-Type: text/markdown
+Requires-Dist: pytest~=7.0; extra == "test"
+Requires-Dist: pytest-cov~=4.0.0; extra == "test"
 
 <div align="center">
 <h1>pytest-codspeed</h1>
 
 [![CI](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml/badge.svg)](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml)
 [![PyPi Version](https://img.shields.io/pypi/v/pytest-codspeed?color=%2334D058&label=pypi)](https://pypi.org/project/pytest-codspeed)
-![Python Version](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
+![Python Version](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
 [![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)
 [![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/CodSpeedHQ/pytest-codspeed)
 
@@ -80,7 +75,7 @@ Pytest plugin to create CodSpeed benchmarks
 
 ## Requirements
 
-**Python**: 3.8 and later
+**Python**: 3.9 and later
 
 **pytest**: any recent version
 
@@ -155,7 +150,7 @@ You can use the [CodSpeedHQ/action](https://github.com/CodSpeedHQ/action) to run
 Example workflow:
 
 ```yaml
-name: benchmarks
+name: CodSpeed
 
 on:
   push:
@@ -165,6 +160,7 @@ on:
 
 jobs:
   benchmarks:
+    name: Run benchmarks
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

{pytest_codspeed-3.0.0b3 → pytest_codspeed-3.1.0}/README.md

@@ -3,7 +3,7 @@
 
 [![CI](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml/badge.svg)](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml)
 [![PyPi Version](https://img.shields.io/pypi/v/pytest-codspeed?color=%2334D058&label=pypi)](https://pypi.org/project/pytest-codspeed)
-![Python Version](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
+![Python Version](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
 [![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)
 [![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/CodSpeedHQ/pytest-codspeed)
 
@@ -13,7 +13,7 @@ Pytest plugin to create CodSpeed benchmarks
 
 ## Requirements
 
-**Python**: 3.8 and later
+**Python**: 3.9 and later
 
 **pytest**: any recent version
 
@@ -88,7 +88,7 @@ You can use the [CodSpeedHQ/action](https://github.com/CodSpeedHQ/action) to run
 Example workflow:
 
 ```yaml
-name: benchmarks
+name: CodSpeed
 
 on:
   push:
@@ -98,6 +98,7 @@ on:
 
 jobs:
   benchmarks:
+    name: Run benchmarks
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

{pytest_codspeed-3.0.0b3 → pytest_codspeed-3.1.0}/pyproject.toml

@@ -1,7 +1,3 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
 [project.urls]
 Homepage = "https://codspeed.io/"
 Documentation = "https://docs.codspeed.io/"
@@ -13,7 +9,7 @@ dynamic = ["version"]
 description = "Pytest plugin to create CodSpeed benchmarks"
 readme = "README.md"
 license = { file = "LICENSE" }
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 authors = [{ name = "Arthur Pastel", email = "arthur@codspeed.io" }]
 keywords = ["codspeed", "benchmark", "performance", "pytest"]
 classifiers = [
@@ -23,7 +19,6 @@ classifiers = [
     "Intended Audience :: Information Technology",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -36,43 +31,65 @@ classifiers = [
 ]
 dependencies = [
     "cffi >= 1.17.1",
-    # cffi doesn't automatically install setuptools with python 3.12+
-    # cf https://github.com/python-cffi/cffi/releases/tag/v1.16.0
-    "setuptools; python_full_version >= '3.12.0'",
     "pytest>=3.8",
-    "filelock >= 3.12.2",
     "rich>=13.8.1",
     "importlib-metadata>=8.5.0; python_version < '3.10'",
 ]
 
 [project.optional-dependencies]
-build = ["semver>=3.0.2"]
 lint = ["mypy ~= 1.11.2", "ruff ~= 0.6.5"]
 compat = [
-    "pytest-benchmark ~= 4.0.0",
+    "pytest-benchmark ~= 5.0.0",
     "pytest-xdist ~= 3.6.1",
     # "pytest-speed>=0.3.5",
 ]
 test = ["pytest ~= 7.0", "pytest-cov ~= 4.0.0"]
+
 [project.entry-points]
 pytest11 = { codspeed = "pytest_codspeed.plugin" }
 
-[tool.hatch.envs.default]
-python = "3.11"
-features = ["lint", "test", "compat"]
+[build-system]
+requires = ["setuptools >= 61", "cffi >= 1.17.1"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+license-files = [] # Workaround of https://github.com/astral-sh/uv/issues/9513
 
-[tool.hatch.envs.test]
-features = ["test"]
+[tool.setuptools.dynamic]
+version = { attr = "pytest_codspeed.__version__" }
 
-[[tool.hatch.envs.test.matrix]]
-python = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
-features = ["compat", "test"]
 
-[tool.hatch.version]
-path = "src/pytest_codspeed/__init__.py"
+[tool.bumpver]
+current_version = "3.1.0"
+version_pattern = "MAJOR.MINOR.PATCH[-TAG]"
+commit_message = "Release v{new_version} 🚀"
+tag_message = "Release v{new_version} 🚀"
+tag_scope = "default"
+allow_dirty = false
+pre_commit_hook = "./scripts/pre-release.sh"
+post_commit_hook = "./scripts/post-release.sh"
+commit = true
+tag = false
+push = false
+
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = ['current_version = "{version}"']
+"src/pytest_codspeed/__init__.py" = [
+    '__version__ = "{pep440_version}"',
+    '__semver_version__ = "{version}"',
+]
+
+[tool.cibuildwheel]
+build = "cp*manylinux*"
+test-extras = ["build", "test", "compat"]
+test-command = "pytest -v --ignore={project}/tests/benchmarks {project}/tests"
 
-[tool.hatch.build.targets.sdist]
-include = ["/src"]
+[tool.cibuildwheel.linux]
+environment = { PYTEST_CODSPEED_FORCE_EXTENSION_BUILD = "1", PYTEST_CODSPEED_FORCE_VALGRIND_TESTS = "1" }
+manylinux-x86_64-image = "manylinux_2_28"
+manylinux-aarch64-image = "manylinux_2_28"
+before-all = "yum -y install valgrind-devel"
 
 [tool.mypy]
 python_version = "3.12"

pytest_codspeed-3.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pytest_codspeed-3.1.0/setup.py

@@ -0,0 +1,53 @@
+import importlib.util
+import os
+import platform
+from pathlib import Path
+
+from setuptools import setup
+
+build_path = (
+    Path(__file__).parent / "src/pytest_codspeed/instruments/valgrind/_wrapper/build.py"
+)
+
+spec = importlib.util.spec_from_file_location("build", build_path)
+assert spec is not None, "The spec should be initialized"
+build = importlib.util.module_from_spec(spec)
+assert spec.loader is not None, "The loader should be initialized"
+spec.loader.exec_module(build)
+
+system = platform.system()
+current_arch = platform.machine()
+
+print(f"System: {system} ({current_arch})")
+
+IS_EXTENSION_BUILDABLE = system == "Linux" and current_arch in [
+    "x86_64",
+    "aarch64",
+]
+
+IS_EXTENSION_REQUIRED = (
+    os.environ.get("PYTEST_CODSPEED_FORCE_EXTENSION_BUILD") is not None
+)
+if IS_EXTENSION_REQUIRED and not IS_EXTENSION_BUILDABLE:
+    raise ValueError(
+        "The extension is required but the current platform is not supported"
+    )
+
+
+ffi_extension = build.ffibuilder.distutils_extension()
+ffi_extension.optional = not IS_EXTENSION_REQUIRED
+
+print(
+    "CodSpeed native extension is "
+    + ("required" if IS_EXTENSION_REQUIRED else "optional")
+)
+
+setup(
+    package_data={
+        "pytest_codspeed": [
+            "instruments/valgrind/_wrapper/*.h",
+            "instruments/valgrind/_wrapper/*.c",
+        ]
+    },
+    ext_modules=[ffi_extension] if IS_EXTENSION_BUILDABLE else [],
+)

{pytest_codspeed-3.0.0b3 → pytest_codspeed-3.1.0}/src/pytest_codspeed/__init__.py

@@ -1,6 +1,6 @@
-__version__ = "3.0.0b3"
+__version__ = "3.1.0"
 # We also have the semver version since __version__ is not semver compliant
-__semver_version__ = "3.0.0-b3"
+__semver_version__ = "3.1.0"
 
 from .plugin import BenchmarkFixture
 

pytest_codspeed-3.1.0/src/pytest_codspeed/instruments/valgrind/_wrapper/__init__.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .wrapper import lib as LibType
+
+
+def get_lib() -> LibType:
+    try:
+        from .dist_callgrind_wrapper import lib  # type: ignore
+
+        return lib
+    except Exception as e:
+        raise Exception("Failed to get a compiled wrapper") from e

pytest_codspeed-3.1.0/src/pytest_codspeed/instruments/valgrind/_wrapper/build.py

@@ -0,0 +1,19 @@
+from pathlib import Path
+
+from cffi import FFI  # type: ignore
+
+wrapper_dir = Path(__file__).parent
+
+ffibuilder = FFI()
+
+ffibuilder.cdef((wrapper_dir / "wrapper.h").read_text())
+
+ffibuilder.set_source(
+    "pytest_codspeed.instruments.valgrind._wrapper.dist_callgrind_wrapper",
+    '#include "wrapper.h"',
+    sources=["src/pytest_codspeed/instruments/valgrind/_wrapper/wrapper.c"],
+    include_dirs=[str(wrapper_dir)],
+)
+
+if __name__ == "__main__":
+    ffibuilder.compile(verbose=True)

{pytest_codspeed-3.0.0b3 → pytest_codspeed-3.1.0}/src/pytest_codspeed/instruments/walltime.py

@@ -7,6 +7,7 @@ from time import get_clock_info, perf_counter_ns
 from typing import TYPE_CHECKING
 
 from rich.console import Console
+from rich.markup import escape
 from rich.table import Table
 from rich.text import Text
 
@@ -54,15 +55,14 @@ class BenchmarkStats:
     mean_ns: float
     stdev_ns: float
 
-    lower_fence_ns: float
     q1_ns: float
     median_ns: float
     q3_ns: float
-    upper_fence_ns: float
 
     rounds: int
     total_time: float
-    outlier_rounds: int
+    iqr_outlier_rounds: int
+    stdev_outlier_rounds: int
     iter_per_round: int
     warmup_iters: int
 
@@ -78,12 +78,22 @@ class BenchmarkStats:
     ) -> BenchmarkStats:
         stdev_ns = stdev(times_ns) if len(times_ns) > 1 else 0
         mean_ns = mean(times_ns)
-        q1_ns, median_ns, q3_ns = quantiles(times_ns, n=4)
+        if len(times_ns) > 1:
+            q1_ns, median_ns, q3_ns = quantiles(times_ns, n=4)
+        else:
+            q1_ns, median_ns, q3_ns = (
+                mean_ns,
+                mean_ns,
+                mean_ns,
+            )
         iqr_ns = q3_ns - q1_ns
-        lower_fence_ns = q1_ns - 1.5 * iqr_ns
-        upper_fence_ns = q3_ns + 1.5 * iqr_ns
-        outliers_rounds = sum(
-            1 for t in times_ns if t < lower_fence_ns or t > upper_fence_ns
+        iqr_outlier_rounds = sum(
+            1 for t in times_ns if t < q1_ns - 1.5 * iqr_ns or t > q3_ns + 1.5 * iqr_ns
+        )
+        stdev_outlier_rounds = sum(
+            1
+            for t in times_ns
+            if t < mean_ns - 3 * stdev_ns or t > mean_ns + 3 * stdev_ns
         )
 
         return cls(
@@ -91,14 +101,13 @@ class BenchmarkStats:
             max_ns=max(times_ns),
             stdev_ns=stdev_ns,
             mean_ns=mean_ns,
-            lower_fence_ns=lower_fence_ns,
             q1_ns=q1_ns,
             median_ns=median_ns,
             q3_ns=q3_ns,
-            upper_fence_ns=upper_fence_ns,
             rounds=rounds,
             total_time=total_time,
-            outlier_rounds=outliers_rounds,
+            iqr_outlier_rounds=iqr_outlier_rounds,
+            stdev_outlier_rounds=stdev_outlier_rounds,
             iter_per_round=iter_per_round,
             warmup_iters=warmup_iters,
         )
@@ -235,7 +244,7 @@ class WallTimeInstrument(Instrument):
             if rsd > 0.1:
                 rsd_text.stylize("red bold")
             table.add_row(
-                bench.name,
+                escape(bench.name),
                 f"{bench.stats.min_ns/bench.stats.iter_per_round:,.0f}ns",
                 rsd_text,
                 f"{bench.stats.total_time:,.2f}s",

{pytest_codspeed-3.0.0b3 → pytest_codspeed-3.1.0}/src/pytest_codspeed/plugin.py

@@ -261,17 +261,15 @@ def _measure(
 ) -> T:
     is_gc_enabled = gc.isenabled()
     if is_gc_enabled:
-        pass
-        # gc.collect()
-        # gc.disable()
+        gc.collect()
+        gc.disable()
     try:
         uri, name = get_git_relative_uri_and_name(nodeid, config.rootpath)
         return plugin.instrument.measure(name, uri, fn, *args, **kwargs)
     finally:
         # Ensure GC is re-enabled even if the test failed
         if is_gc_enabled:
-            pass
-            # gc.enable()
+            gc.enable()
 
 
 def wrap_runtest(
@@ -322,6 +320,18 @@ def pytest_sessionfinish(session: pytest.Session, exitstatus):
 class BenchmarkFixture:
     """The fixture that can be used to benchmark a function."""
 
+    @property  # type: ignore
+    def __class__(self):
+        # Bypass the pytest-benchmark fixture class check
+        # https://github.com/ionelmc/pytest-benchmark/commit/d6511e3474931feb4e862948128e0c389acfceec
+        if IS_PYTEST_BENCHMARK_INSTALLED:
+            from pytest_benchmark.fixture import (
+                BenchmarkFixture as PytestBenchmarkFixture,
+            )
+
+            return PytestBenchmarkFixture
+        return BenchmarkFixture
+
     def __init__(self, request: pytest.FixtureRequest):
         self.extra_info: dict = {}
 

pytest_codspeed-3.1.0/src/pytest_codspeed.egg-info/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.1
+Name: pytest-codspeed
+Version: 3.1.0
+Summary: Pytest plugin to create CodSpeed benchmarks
+Author-email: Arthur Pastel <arthur@codspeed.io>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2022 CodSpeed and contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+        
+Project-URL: Homepage, https://codspeed.io/
+Project-URL: Documentation, https://docs.codspeed.io/
+Project-URL: Source, https://github.com/CodSpeedHQ/pytest-codspeed
+Keywords: codspeed,benchmark,performance,pytest
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Benchmark
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: cffi>=1.17.1
+Requires-Dist: pytest>=3.8
+Requires-Dist: rich>=13.8.1
+Requires-Dist: importlib-metadata>=8.5.0; python_version < "3.10"
+Provides-Extra: lint
+Requires-Dist: mypy~=1.11.2; extra == "lint"
+Requires-Dist: ruff~=0.6.5; extra == "lint"
+Provides-Extra: compat
+Requires-Dist: pytest-benchmark~=5.0.0; extra == "compat"
+Requires-Dist: pytest-xdist~=3.6.1; extra == "compat"
+Provides-Extra: test
+Requires-Dist: pytest~=7.0; extra == "test"
+Requires-Dist: pytest-cov~=4.0.0; extra == "test"
+
+<div align="center">
+<h1>pytest-codspeed</h1>
+
+[![CI](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml/badge.svg)](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml)
+[![PyPi Version](https://img.shields.io/pypi/v/pytest-codspeed?color=%2334D058&label=pypi)](https://pypi.org/project/pytest-codspeed)
+![Python Version](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
+[![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)
+[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/CodSpeedHQ/pytest-codspeed)
+
+Pytest plugin to create CodSpeed benchmarks
+
+</div>
+
+## Requirements
+
+**Python**: 3.9 and later
+
+**pytest**: any recent version
+
+## Installation
+
+```shell
+pip install pytest-codspeed
+```
+
+## Usage
+
+### Creating benchmarks
+
+Creating benchmarks with `pytest-codspeed` is compatible with the standard `pytest-benchmark` API. So if you already have benchmarks written with it, you can start using `pytest-codspeed` right away.
+
+#### Marking a whole test function as a benchmark with `pytest.mark.benchmark`
+
+```python
+import pytest
+from statistics import median
+
+@pytest.mark.benchmark
+def test_median_performance():
+    return median([1, 2, 3, 4, 5])
+```
+
+#### Benchmarking selected lines of a test function with the `benchmark` fixture
+
+```python
+import pytest
+from statistics import mean
+
+def test_mean_performance(benchmark):
+    # Precompute some data useful for the benchmark but that should not be
+    # included in the benchmark time
+    data = [1, 2, 3, 4, 5]
+
+    # Benchmark the execution of the function
+    benchmark(lambda: mean(data))
+
+
+def test_mean_and_median_performance(benchmark):
+    # Precompute some data useful for the benchmark but that should not be
+    # included in the benchmark time
+    data = [1, 2, 3, 4, 5]
+
+    # Benchmark the execution of the function:
+    # The `@benchmark` decorator will automatically call the function and
+    # measure its execution
+    @benchmark
+    def bench():
+        mean(data)
+        median(data)
+```
+
+### Running benchmarks
+
+#### Testing the benchmarks locally
+
+If you want to run only the benchmarks tests locally, you can use the `--codspeed` pytest flag:
+
+```shell
+pytest tests/ --codspeed
+```
+
+> **Note:** Running `pytest-codspeed` locally will not produce any performance reporting. It's only useful for making sure that your benchmarks are working as expected. If you want to get performance reporting, you should run the benchmarks in your CI.
+
+#### In your CI
+
+You can use the [CodSpeedHQ/action](https://github.com/CodSpeedHQ/action) to run the benchmarks in Github Actions and upload the results to CodSpeed.
+
+Example workflow:
+
+```yaml
+name: CodSpeed
+
+on:
+  push:
+    branches:
+      - "main" # or "master"
+  pull_request:
+
+jobs:
+  benchmarks:
+    name: Run benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v3
+        with:
+          token: ${{ secrets.CODSPEED_TOKEN }}
+          run: pytest tests/ --codspeed
+```

pytest_codspeed-3.1.0/src/pytest_codspeed.egg-info/SOURCES.txt

@@ -0,0 +1,26 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+src/pytest_codspeed/__init__.py
+src/pytest_codspeed/plugin.py
+src/pytest_codspeed/py.typed
+src/pytest_codspeed/utils.py
+src/pytest_codspeed.egg-info/PKG-INFO
+src/pytest_codspeed.egg-info/SOURCES.txt
+src/pytest_codspeed.egg-info/dependency_links.txt
+src/pytest_codspeed.egg-info/entry_points.txt
+src/pytest_codspeed.egg-info/requires.txt
+src/pytest_codspeed.egg-info/top_level.txt
+src/pytest_codspeed/instruments/__init__.py
+src/pytest_codspeed/instruments/walltime.py
+src/pytest_codspeed/instruments/valgrind/__init__.py
+src/pytest_codspeed/instruments/valgrind/_wrapper/__init__.py
+src/pytest_codspeed/instruments/valgrind/_wrapper/build.py
+src/pytest_codspeed/instruments/valgrind/_wrapper/wrapper.c
+src/pytest_codspeed/instruments/valgrind/_wrapper/wrapper.h
+src/pytest_codspeed/instruments/valgrind/_wrapper/wrapper.pyi
+tests/test_pytest_plugin.py
+tests/test_pytest_plugin_cpu_instrumentation.py
+tests/test_pytest_plugin_walltime.py
+tests/test_utils.py

pytest_codspeed-3.1.0/src/pytest_codspeed.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+