Skip to content

Commit 60b9235

Browse files
committed
Remove old benchmark documentation and add a new one to close #108.
1 parent eb88e67 commit 60b9235

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

docs/contrib/index.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,8 @@ dependencies, use:
88
99
pip install -e ".[test]"
1010
11-
To also install 3rd party JSON libraries used for running benchmarks, use:
12-
13-
.. code::
14-
15-
pip install -e ".[benchmark]"
16-
17-
To run the tests, just type ``pytest``. To also run the benchmarks, use
18-
``pytest --runslow``. ``--runslow`` will also run the NumPy integration tests.
11+
To run the tests, just type ``pytest``. To also run some slow integration
12+
tests, use ``pytest --runslow``.
1913

2014
To properly test builds on Windows, you need both a recent version of Visual
2115
Studio as well as VS2015, patch 3. Older versions of CPython required portable
@@ -51,6 +45,16 @@ once, so to force Cython to rebuild it, use ``FORCE_REBUILD``:
5145
5246
BUILD_WITH_CYTHON=1 FORCE_REBUILD=1 python setup.py develop
5347
48+
Benchmarks
49+
----------
50+
51+
The benchmarks that used to exist in this project have been moved into a
52+
sister project, `json_benchmark`_. This project contains a number of
53+
benchmarks for various JSON libraries, including pysimdjson. It also tests
54+
for correctness, so it can be used to verify that simdjson is working
55+
correctly.
56+
5457
.. _Developer Command Prompt: https://docs.microsoft.com/en-us/dotnet/
5558
framework/tools/developer-command-prompt-for-vs
5659
.. _Cython: https://cython.readthedocs.io/en/latest/
60+
.. _json_benchmark: https://github.com/tktech/json_benchmark

setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@
105105
'pytest',
106106
'pytest-benchmark',
107107
'flake8',
108-
'coverage'
108+
'coverage',
109+
'numpy'
109110
]
110111
},
111112
ext_modules=extensions,

0 commit comments

Comments
 (0)