Rename performance project to: pyperformance

Author: vstinner

.gitignore

@@ -10,7 +10,7 @@
 # Created by setup.py sdist
 build/
 dist/
-performance.egg-info/
+pyperformance.egg-info/
 
 # Created by the pyperformance script
 venv/

.travis.yml

@@ -7,7 +7,8 @@ python:
     - pypy
 install:
     - pip install -U 'setuptools>=18.5' 'pip>=6.0'
-    # Need to install performance, performance/tests/test_compare.py imports it
+    # Need to install pyperformance,
+    # pyperformance/tests/test_compare.py imports it
     - pip install -e .
 script:
     - python runtests.py

README.rst

@@ -2,22 +2,22 @@
 The Python Benchmark Suite
 ##########################
 
-.. image:: https://img.shields.io/pypi/v/performance.svg
-   :alt: Latest performance release on the Python Cheeseshop (PyPI)
-   :target: https://pypi.python.org/pypi/performance
+.. image:: https://img.shields.io/pypi/v/pyperformance.svg
+   :alt: Latest pyperformance release on the Python Cheeseshop (PyPI)
+   :target: https://pypi.python.org/pypi/pyperformance
 
-.. image:: https://travis-ci.org/python/performance.svg?branch=master
-   :alt: Build status of performance on Travis CI
-   :target: https://travis-ci.org/python/performance
+.. image:: https://travis-ci.org/python/pyperformance.svg?branch=master
+   :alt: Build status of pyperformance on Travis CI
+   :target: https://travis-ci.org/python/pyperformance
 
-The ``performance`` project is intended to be an authoritative source of
+The ``pyperformance`` project is intended to be an authoritative source of
 benchmarks for all Python implementations. The focus is on real-world
 benchmarks, rather than synthetic benchmarks, using whole applications when
 possible.
 
-* `performance documentation <http://pyperformance.readthedocs.io/>`_
-* `performance GitHub project <https://github.com/python/performance>`_
+* `pyperformance documentation <http://pyperformance.readthedocs.io/>`_
+* `pyperformance GitHub project <https://github.com/python/pyperformance>`_
   (source code, issues)
-* `Download performance on PyPI <https://pypi.python.org/pypi/performance>`_
+* `Download pyperformance on PyPI <https://pypi.python.org/pypi/pyperformance>`_
 
-performance is distributed under the MIT license.
+pyperformance is distributed under the MIT license.

TODO.rst

@@ -55,7 +55,7 @@ Port PyPy benchmarks
 
 Repository: https://bitbucket.org/pypy/benchmarks/
 
-Different from performance?
+Different from pyperformance?
 
 * json_bench
 
@@ -95,13 +95,13 @@ Deliberate choice to not add it:
 
 Done:
 
-* ai (called bm_nqueens in performance)
+* ai (called bm_nqueens in pyperformance)
 * bm_chameleon
 * bm_mako
 * chaos
 * crypto_pyaes
 * deltablue
-* django (called django_template in performance)
+* django (called django_template in pyperformance)
 * dulwich_log
 * fannkuch
 * float
@@ -112,11 +112,11 @@ Done:
 * html5lib
 * mdp
 * meteor-contest
-* nbody_modified (called nbody in performance)
+* nbody_modified (called nbody in pyperformance)
 * nqueens
 * pidigits
-* pyflate-fast (called pyflate in performance)
-* raytrace-simple (called raytrace in performance)
+* pyflate-fast (called pyflate in pyperformance)
+* raytrace-simple (called raytrace in pyperformance)
 * richards
 * scimark_fft
 * scimark_lu
@@ -140,7 +140,7 @@ pyston benchmarks
 
 Add benchmarks from the Pyston benchmark suite:
 https://github.com/dropbox/pyston-perf
-and convince Pyston to use performance :-)
+and convince Pyston to use pyperformance :-)
 
 TODO:
 
@@ -150,7 +150,7 @@ TODO:
 - django_template3_10x
 - django_template3
 - django_template
-- fasta (it's different than performance "regex_dna")
+- fasta (it's different than pyperformance "regex_dna")
 - interp2
 - pyxl_bench_10x
 - pyxl_bench2_10x
@@ -172,4 +172,4 @@ Done:
 - richards
 - sqlalchemy_imperative, sqlalchemy_imperative2, sqlalchemy_imperative2_10x:
   use --rows cmdline option to control the number of SQL rows
-- sre_compile_ubench: performance has a much more complete benchmark on regex
+- sre_compile_ubench: pyperformance has a much more complete benchmark on regex

doc/benchmark.conf.sample

@@ -28,7 +28,7 @@ git_remote = remotes/origin
 # Create files into bench_dir:
 # - bench_dir/bench-xxx.log
 # - bench_dir/prefix/: where Python is installed
-# - bench_dir/venv/: Virtual environment used by performance
+# - bench_dir/venv/: Virtual environment used by pyperformance
 bench_dir = ~/bench_tmpdir
 
 # Link Time Optimization (LTO)?
@@ -64,10 +64,10 @@ install = True
 # Run "sudo python3 -m pyperf system tune" before running benchmarks?
 system_tune = True
 
-# --benchmarks option for 'performance run'
+# --benchmarks option for 'pyperformance run'
 benchmarks =
 
-# --affinity option for 'pyperf system tune' and 'performance run'
+# --affinity option for 'pyperf system tune' and 'pyperformance run'
 affinity =
 
 # Upload generated JSON file?

doc/benchmarks.rst

@@ -7,7 +7,7 @@ Available Groups
 ================
 
 Like individual benchmarks (see "Available benchmarks" below), benchmarks group
-are allowed after the `-b` option. Use ``python3 -m performance list_groups``
+are allowed after the `-b` option. Use ``python3 -m pyperformance list_groups``
 to list groups and their benchmarks.
 
 Available benchmark groups:
@@ -23,13 +23,13 @@ Available benchmark groups:
   start-up time.
 * ``template``: Templating libraries
 
-Use the ``python3 -m performance list_groups`` command to list groups and their
+Use the ``python3 -m pyperformance list_groups`` command to list groups and their
 benchmarks.
 
 Available Benchmarks
 ====================
 
-In performance 0.5.5, the following microbenchmarks have been removed because
+In pyperformance 0.5.5, the following microbenchmarks have been removed because
 they are too short, not representative of real applications and are too
 unstable.
 
@@ -42,7 +42,7 @@ unstable.
 2to3
 ----
 
-Run the 2to3 tool on the ``performance/benchmarks/data/2to3/`` directory: copy
+Run the 2to3 tool on the ``pyperformance/benchmarks/data/2to3/`` directory: copy
 of the ``django/core/*.py`` files of Django 1.1.4, 9 files.
 
 Run the ``python -m lib2to3 -f all <files>`` command where ``python`` is
@@ -89,7 +89,7 @@ Copyright (C) 2005 Carl Friedrich Bolz
 
 Image generated by bm_chaos (took 3 sec on CPython 3.5) with the command::
 
-    python3 performance/benchmarks/bm_chaos.py --worker -l1 -w0 -n1 --filename chaos.ppm --width=512 --height=512 --iterations 50000
+    python3 pyperformance/benchmarks/bm_chaos.py --worker -l1 -w0 -n1 --filename chaos.ppm --width=512 --height=512 --iterations 50000
 
 
 crypto_pyaes
@@ -139,7 +139,7 @@ dulwich_log
 -----------
 
 Iterate on commits of the asyncio Git repository using the Dulwich module.
-Use ``performance/benchmarks/data/asyncio.git/`` repository.
+Use ``pyperformance/benchmarks/data/asyncio.git/`` repository.
 
 Pseudo-code of the benchmark::
 
@@ -215,7 +215,7 @@ See the `Mercurial project <https://www.mercurial-scm.org/>`_.
 html5lib
 --------
 
-Parse the ``performance/benchmarks/data/w3_tr_html5.html`` HTML file (132 KB)
+Parse the ``pyperformance/benchmarks/data/w3_tr_html5.html`` HTML file (132 KB)
 using ``html5lib``.  The file is the HTML 5 specification, but truncated to
 parse the file in less than 1 second (around 250 ms).
 
@@ -385,7 +385,7 @@ pyflate
 -------
 
 Benchmark of a pure-Python bzip2 decompressor: decompress the
-``performance/benchmarks/data/interpreter.tar.bz2`` file in memory.
+``pyperformance/benchmarks/data/interpreter.tar.bz2`` file in memory.
 
 Copyright 2006--2007-01-21 Paul Sladen:
 http://www.paul.sladen.org/projects/compression/
@@ -427,7 +427,7 @@ From http://www.lshift.net/blog/2008/10/29/toy-raytracer-in-python
 
 Image generated by the command (took 68.4 sec on CPython 3.5)::
 
-    python3 performance/benchmarks/bm_raytrace.py --worker --filename=raytrace.ppm  -l1 -w0 -n1 -v --width=800 --height=600
+    python3 pyperformance/benchmarks/bm_raytrace.py --worker --filename=raytrace.ppm  -l1 -w0 -n1 -v --width=800 --height=600
 
 
 regex_compile
@@ -525,7 +525,7 @@ spambayes
 
 Run a canned mailbox through a SpamBayes ham/spam classifier.
 
-Data files from ``performance/benchmarks/data`` directory:
+Data files from ``pyperformance/benchmarks/data`` directory:
 
 * ``spambayes_mailbox``: Mailbox file which contains 64 emails
 * ``spambayes_hammie.pkl``: Ham data (serialized by pickle)

doc/changelog.rst

@@ -4,6 +4,7 @@ Changelog
 Version 0.8.1
 -------------
 
+* Project renamed from "performance" to "pyperformance"
 * Upgrade pyperf from version 1.6.0 to 1.6.1. The project has been renamed from
   "perf" to "pyperf". Update imports.
 * Issue #54: Update Genshi to 0.7.3. It is now compatible with Python 3.8.

doc/index.rst

@@ -2,17 +2,17 @@
 The Python Performance Benchmark Suite
 ######################################
 
-The ``performance`` project is intended to be an authoritative source of
+The ``pyperformance`` project is intended to be an authoritative source of
 benchmarks for all Python implementations. The focus is on real-world
 benchmarks, rather than synthetic benchmarks, using whole applications when
 possible.
 
-* `performance documentation <http://pyperformance.readthedocs.io/>`_
-* `performance GitHub project <https://github.com/python/performance>`_
+* `pyperformance documentation <http://pyperformance.readthedocs.io/>`_
+* `pyperformance GitHub project <https://github.com/python/pyperformance>`_
   (source code, issues)
-* `Download performance on PyPI <https://pypi.python.org/pypi/performance>`_
+* `Download pyperformance on PyPI <https://pypi.python.org/pypi/pyperformance>`_
 
-performance is distributed under the MIT license.
+pyperformance is distributed under the MIT license.
 
 Documenation:
 
@@ -27,7 +27,7 @@ Documenation:
 Other Python Benchmarks:
 
 * CPython: `speed.python.org <https://speed.python.org/>`_ uses pyperf,
-  performance and `Codespeed <https://github.com/tobami/codespeed/>`_ (Django
+  pyperformance and `Codespeed <https://github.com/tobami/codespeed/>`_ (Django
   web application)
 * PyPy: `speed.pypy.org <http://speed.pypy.org/>`_
   uses `PyPy benchmarks <https://bitbucket.org/pypy/benchmarks>`_
@@ -41,7 +41,7 @@ Other Python Benchmarks:
 
 See also the `Python speed mailing list
 <https://mail.python.org/mailman/listinfo/speed>`_ and the `Python pyperf module
-<http://pyperf.readthedocs.io/>`_ (used by performance).
+<http://pyperf.readthedocs.io/>`_ (used by pyperformance).
 
 Image generated by bm_raytrace (pure Python raytrace):
 

doc/usage.rst

@@ -5,15 +5,15 @@ Usage
 Installation
 ============
 
-Command to install performance::
+Command to install pyperformance::
 
-    python3 -m pip install performance
+    python3 -m pip install pyperformance
 
 The command installs a new ``pyperformance`` program.
 
 If needed, ``pyperf`` and ``six`` dependencies are installed automatically.
 
-performance works on Python 2.7, 3.4 and newer.
+pyperformance works on Python 2.7, 3.4 and newer.
 
 On Python 2, the ``virtualenv`` program (or the Python module) is required
 to create virtual environments. On Python 3, the ``venv`` module of the
@@ -27,7 +27,7 @@ extension. Commands on Fedora to install dependencies:
 * Python 3: ``sudo dnf install python3-devel``
 * PyPy: ``sudo dnf install pypy-devel``
 
-In some cases, performance fails to create a virtual environment. In this case,
+In some cases, pyperformance fails to create a virtual environment. In this case,
 upgrading virtualenv on the system can fix the issue. Example::
 
     sudo python2 -m pip install -U virtualenv
@@ -42,8 +42,8 @@ Commands to compare Python 2 and Python 3 performances::
     pyperformance run --python=python3 -o py3.json
     pyperformance compare py2.json py3.json
 
-Note: ``python3 -m performance ...`` syntax works as well (ex: ``python3 -m
-performance run -o py3.json``), but requires to install performance on each
+Note: ``python3 -m pyperformance ...`` syntax works as well (ex: ``python3 -m
+pyperformance run -o py3.json``), but requires to install pyperformance on each
 tested Python version.
 
 JSON files are produced by the pyperf module and so can be analyzed using pyperf
@@ -141,7 +141,7 @@ Options of the ``list`` command::
                         except the negative arguments. Otherwise we run only
                         the positive arguments.
 
-Use ``python3 -m performance list -b all`` to list all benchmarks.
+Use ``python3 -m pyperformance list -b all`` to list all benchmarks.
 
 
 venv
@@ -247,31 +247,31 @@ How to get stable benchmarks
 
 * Run ``python3 -m pyperf system tune`` command
 * Compile Python using LTO (Link Time Optimization) and PGO (profile guided
-  optimizations): use the :ref:`performance compile <cmd-compile>` command with
+  optimizations): use the :ref:`pyperformance compile <cmd-compile>` command with
   uses LTO and PGO by default
 * See advices of the pyperf documentation:
   `How to get reproductible benchmark results
   <http://pyperf.readthedocs.io/en/latest/run_benchmark.html#how-to-get-reproductible-benchmark-results>`_.
 
 
-performance virtual environment
-===============================
+pyperformance virtual environment
+=================================
 
-To run benchmarks, performance first creates a virtual environment. It installs
+To run benchmarks, pyperformance first creates a virtual environment. It installs
 requirements with fixed versions to get a reproductible environment. The system
 Python has unknown module installed with unknown versions, and can have
 ``.pth`` files run at Python startup which can modify Python behaviour or at
 least slow down Python startup.
 
 
-What is the goal of performance
-===============================
+What is the goal of pyperformance
+=================================
 
 A benchmark is always written for a specific purpose. Depending how the
 benchmark is written and how the benchmark is run, the result can be different
 and so have a different meaning.
 
-The performance benchmark suite has multiple goals:
+The pyperformance benchmark suite has multiple goals:
 
 * Help to detect performance regression in a Python implementation
 * Validate that an optimization change makes Python faster and don't
@@ -284,7 +284,7 @@ The performance benchmark suite has multiple goals:
 Don't disable GC nor ASLR
 -------------------------
 
-The pyperf module and performance benchmarks are designed to produce
+The pyperf module and pyperformance benchmarks are designed to produce
 reproductible results, but not at the price of running benchmarks in a special
 mode which would not be used to run applications in production. For these
 reasons, the Python garbage collector, Python randomized hash function and
@@ -313,11 +313,11 @@ Warmups and steady state
 
 A borderline issue are the benchmarks "warmups". The first values of each
 worker process are always slower: 10% slower in the best case, it can be 1000%
-slower or more on PyPy. Right now (2017-04-14), performance ignore first values
+slower or more on PyPy. Right now (2017-04-14), pyperformance ignore first values
 considered as warmup until a benchmark reachs its "steady state". The "steady
 state" can include temporary spikes every 5 values (ex: caused by the garbage
 collector), and it can still imply further JIT compiler optimizations but with
-a "low" impact on the average performance.
+a "low" impact on the average pyperformance.
 
 To be clear "warmup" and "steady state" are a work-in-progress and a very
 complex topic, especially on PyPy and its JIT compiler.

performance/__main__.py

@@ -0,0 +1,2 @@
+import pyperformance.cli
+pyperformance.cli.main()