Skip to content

Commit 3126e84

Browse files
committed
Rename pytest-ordering2 to pytest-order
- makes it consistent with the "order" marker, and more convenient - repository is also renamed
1 parent 766f4b5 commit 3126e84

File tree

13 files changed

+48
-47
lines changed

13 files changed

+48
-47
lines changed

CHANGELOG.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# pytest-ordering2 Release Notes
1+
# pytest-order Release Notes
22

33
## Unreleased
44

55
### Changes
66
- changed the used marker from ``run`` to ``order``, removed all additional
77
markers (see [#38](https://github.com/ftobia/pytest-ordering/issues/38))
8+
- renamed repository and package from ``pytest-orderin2`` to ``pytest-order``
89

910
## [Version 0.7.0](https://pypi.org/project/pytest-ordering2/0.7.0/)
1011
Imported version from [pytest-ordering](https://github.com/ftobia/pytest-ordering),
@@ -25,4 +26,4 @@ including some PRs (manually merged).
2526
- added more pytest versions, fix pytest-cov compatibility issue,
2627
remove Python 3.4, add Python 3.8
2728
(imported from [PR #74](https://github.com/ftobia/pytest-ordering/pull/74))
28-
- moved documentation to [GitHub Pages](https://mrbean-bremen.github.io/pytest-ordering2/)
29+
- moved documentation to [GitHub Pages](https://mrbean-bremen.github.io/pytest-order/)

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
pytest-ordering2 [![PyPI version](https://badge.fury.io/py/pytest-ordering2.svg)](https://badge.fury.io/py/pytest-ordering2)
1+
pytest-order [![PyPI version](https://badge.fury.io/py/pytest-ordering2.svg)](https://badge.fury.io/py/pytest-ordering2)
22
================
33
This is a fork of [pytest-ordering](https://github.com/ftobia/pytest-ordering).
44
That project is not maintained anymore, and there are several helpful PRs
@@ -10,9 +10,9 @@ organization as outlined in
1010
happens, this fork will be obsolete.
1111

1212

13-
pytest-ordering2 is a pytest plugin to run your tests in a specific order.
13+
pytest-order is a pytest plugin to run your tests in a specific order.
1414

15-
[![Build Status](https://travis-ci.org/mrbean-bremen/pytest-ordering2.svg?branch=master)](https://travis-ci.org/mrbean-bremen/pytest-ordering2)
15+
[![Build Status](https://travis-ci.org/mrbean-bremen/pytest-order.svg?branch=master)](https://travis-ci.org/mrbean-bremen/pytest-order)
1616

1717
Have you ever wanted to easily run one of your tests before any others run?
1818
Or run some tests last? Or run this one test before that other test? Or
@@ -22,7 +22,7 @@ Now you can.
2222

2323
Install with:
2424

25-
pip install pytest-ordering2
25+
pip install pytest-order
2626

2727
This defines some pytest markers that you can use in your code.
2828

@@ -51,4 +51,4 @@ Yields this output:
5151

5252
=========================== 2 passed in 0.01 seconds ===========================
5353

54-
You can find more information in the [documentation](https://mrbean-bremen.github.io/pytest-ordering2/).
54+
You can find more information in the [documentation](https://mrbean-bremen.github.io/pytest-order/).

docs/Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,17 @@ qthelp:
8585
@echo
8686
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
8787
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pytest-ordering.qhcp"
88+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pytest-order.qhcp"
8989
@echo "To view the help file:"
90-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pytest-ordering.qhc"
90+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pytest-order.qhc"
9191

9292
devhelp:
9393
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
9494
@echo
9595
@echo "Build finished."
9696
@echo "To view the help file:"
97-
@echo "# mkdir -p $$HOME/.local/share/devhelp/pytest-ordering"
98-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pytest-ordering"
97+
@echo "# mkdir -p $$HOME/.local/share/devhelp/pytest-order"
98+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pytest-order"
9999
@echo "# devhelp"
100100

101101
epub:

docs/make.bat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@ if "%1" == "qthelp" (
115115
echo.
116116
echo.Build finished; now you can run "qcollectiongenerator" with the ^
117117
.qhcp project file in %BUILDDIR%/qthelp, like this:
118-
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pytest-ordering.qhcp
118+
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pytest-order.qhcp
119119
echo.To view the help file:
120-
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pytest-ordering.ghc
120+
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pytest-order.ghc
121121
goto end
122122
)
123123

docs/source/conf.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# pytest-ordering documentation build configuration file, created by
3+
# pytest-order documentation build configuration file, created by
44
# sphinx-quickstart on Mon Mar 17 18:20:44 2014.
55
#
66
# This file is execfile()d with the current directory set to its
@@ -50,14 +50,14 @@
5050
master_doc = 'index'
5151

5252
# General information about the project.
53-
project = u'pytest-ordering2'
53+
project = u'pytest-order'
5454
copyright = u'2014, Frank Tobia'
5555

5656
# The version info for the project you're documenting, acts as replacement for
5757
# |version| and |release|, also used in various other places throughout the
5858
# built documents.
5959
#
60-
exec(open(os.path.join(__here__, '..', '..', 'pytest_ordering2',
60+
exec(open(os.path.join(__here__, '..', '..', 'pytest_order',
6161
'_version.py')).read())
6262
# The short X.Y version.
6363
version = __version__
@@ -185,7 +185,7 @@
185185
#html_file_suffix = None
186186

187187
# Output file base name for HTML help builder.
188-
htmlhelp_basename = 'pytest-orderingdoc'
188+
htmlhelp_basename = 'pytest-orderdoc'
189189

190190

191191
# -- Options for LaTeX output ---------------------------------------------
@@ -205,7 +205,7 @@
205205
# (source start file, target name, title,
206206
# author, documentclass [howto, manual, or own class]).
207207
latex_documents = [
208-
('index', 'pytest-ordering.tex', u'pytest-ordering2 Documentation',
208+
('index', 'pytest-order.tex', u'pytest-order Documentation',
209209
u'Frank Tobia', 'manual'),
210210
]
211211

@@ -235,7 +235,7 @@
235235
# One entry per manual page. List of tuples
236236
# (source start file, name, description, authors, manual section).
237237
man_pages = [
238-
('index', 'pytest-ordering2', u'pytest-ordering2 Documentation',
238+
('index', 'pytest-order', u'pytest-order Documentation',
239239
[u'Frank Tobia'], 1)
240240
]
241241

@@ -249,8 +249,8 @@
249249
# (source start file, target name, title, author,
250250
# dir menu entry, description, category)
251251
texinfo_documents = [
252-
('index', 'pytest-ordering2', u'pytest-ordering2 Documentation',
253-
u'Frank Tobia', 'pytest-ordering2', 'One line description of project.',
252+
('index', 'pytest-order', u'pytest-order Documentation',
253+
u'Frank Tobia', 'pytest-order', 'One line description of project.',
254254
'Miscellaneous'),
255255
]
256256

docs/source/index.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
pytest-ordering2: run your tests in order
1+
pytest-order: run your tests in order
22
==========================================
33

4-
pytest-ordering2 is a pytest plugin to run your tests in any order that
4+
pytest-order is a pytest plugin to run your tests in any order that
55
you specify. It provides the marker ``order``, that defines when your tests
66
should run in relation to each other. They can be absolute (i.e. first, or
77
second-to-last) or relative (i.e. run this test before this other test).
88

99
Supported Python and pytest versions
1010
------------------------------------
1111

12-
pytest-ordering2 supports python 2.7, 3.5 - 3.8, and pypy, and is
12+
pytest-order supports python 2.7, 3.5 - 3.8, and pypy, and is
1313
compatible with pytest 3.6.0 or newer.
1414

1515

@@ -41,7 +41,7 @@ Here is the output:
4141

4242
=========================== 2 passed in 0.01 seconds ===========================
4343

44-
With pytest-ordering, you can change the default ordering as follows:
44+
With pytest-order, you can change the default ordering as follows:
4545

4646
.. code:: python
4747
@@ -197,13 +197,13 @@ You may sometimes find that you want to suggest an ordering of tests, while
197197
allowing it to be overridden for good reason. For example, if you run your test
198198
suite in parallel and have a number of tests which are particularly slow, it
199199
might be desirable to start those tests running first, in order to optimize
200-
your completion time. You can use the pytest-ordering2 plugin to inform pytest
200+
your completion time. You can use the pytest-order plugin to inform pytest
201201
of this.
202202
Now suppose you also want to prioritize tests which failed during the
203203
previous run, by using the ``--failed-first`` option. By default,
204-
pytest-ordering2 will override the ``--failed-first`` order, but by adding the
204+
pytest-order will override the ``--failed-first`` order, but by adding the
205205
``--indulgent-ordering`` option, you can ask pytest to run the sort from
206-
pytest-ordering2 *before* the sort from ``--failed-first``, allowing the failed
206+
pytest-order *before* the sort from ``--failed-first``, allowing the failed
207207
tests to be sorted to the front.
208208

209209

pytest_ordering2/__init__.py renamed to pytest_order/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,21 @@ def pytest_configure(config):
3232
"""Register the "order" marker and configure the plugin depending
3333
on the CLI options"""
3434

35-
provided_by_pytest_ordering = (
36-
'Provided by pytest-ordering2. '
37-
'See also: http://pytest-ordering.readthedocs.org/'
35+
provided_by_pytest_order = (
36+
'Provided by pytest-order. '
37+
'See also: https://mrbean-bremen.github.io/pytest-order/'
3838
)
3939

4040
config_line = (
4141
'order: specify ordering information for when tests should run '
42-
'in relation to one another. ' + provided_by_pytest_ordering
42+
'in relation to one another. ' + provided_by_pytest_order
4343
)
4444
config.addinivalue_line('markers', config_line)
4545

4646
for mark_name in orders_map.keys():
4747
config_line = '{}: run test {}. {}'.format(mark_name,
4848
mark_name.replace('_', ' '),
49-
provided_by_pytest_ordering)
49+
provided_by_pytest_order)
5050
config.addinivalue_line('markers', config_line)
5151

5252
if config.getoption('indulgent-ordering'):
File renamed without changes.

setup.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,25 @@
55

66
__here__ = os.path.abspath(os.path.dirname(__file__))
77

8-
from pytest_ordering2 import __version__
8+
from pytest_order import __version__
99

1010
with open(os.path.join(__here__, 'README.md')) as f:
1111
LONG_DESCRIPTION = f.read()
1212

1313

1414
setup(
15-
name='pytest-ordering2',
15+
name='pytest-order',
1616
description='pytest plugin to run your tests in a specific order',
1717
long_description=LONG_DESCRIPTION,
1818
long_description_content_type='text/markdown',
1919
version=__version__,
2020
author='mrbean-bremen',
2121
author_email='[email protected]',
22-
url='https://github.com/mrbean-bremen/pytest-ordering2',
23-
packages=['pytest_ordering2'],
22+
url='https://github.com/mrbean-bremen/pytest-order',
23+
packages=['pytest_order'],
2424
entry_points={
2525
'pytest11': [
26-
'pytest_ordering2 = pytest_ordering2',
26+
'pytest_order = pytest_order',
2727
]
2828
},
2929
install_requires=['pytest>=3.6'],

tests/test_indulgent_ordering.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import pytest
44

5-
import pytest_ordering2
5+
import pytest_order
66

77
pytest_plugins = ["pytester"]
88

@@ -27,14 +27,14 @@ def test_me_first():
2727
"""
2828
)
2929
args = ["--quiet", "--color=no", testname]
30-
pytest.main(args, [pytest_ordering2])
30+
pytest.main(args, [pytest_order])
3131
out, err = capsys.readouterr()
3232
assert "..F" in out
3333
args.insert(0, "--ff")
34-
pytest.main(args, [pytest_ordering2])
34+
pytest.main(args, [pytest_order])
3535
out, err = capsys.readouterr()
3636
assert "..F" in out
3737
args.insert(0, "--indulgent-ordering")
38-
pytest.main(args, [pytest_ordering2])
38+
pytest.main(args, [pytest_order])
3939
out, err = capsys.readouterr()
4040
assert "F.." in out

0 commit comments

Comments
 (0)