Skip to content

Commit 1245405

Browse files
saxixsaxix
committed
Merge branch 'release/1.3'
* release/1.3: update CHANGELOG add python 3.4 support updates documentation fixes setup.py description
2 parents 22074ef + 2a4e24d commit 1245405

File tree

9 files changed

+245
-38
lines changed

9 files changed

+245
-38
lines changed

‎CHANGELOG

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
1.3
2+
---
3+
* fixes url in setup.py
4+
* add ability to dump version using setuptools ``pkg_resources``
5+
* python 3.3/3.4
6+
17
1.2
28
---
39
* changed output layout

‎README.rst

Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
pytest-echo
22
===========
33

4-
Print environment variables, package version and django settings.
54

6-
Useful in the continuous integration to dump env configuration.
5+
.. image:: https://pypip.in/v/pytest-echo/badge.png
6+
:target: https://crate.io/packages/pytest-echo/
7+
8+
.. image:: https://pypip.in/d/pytest-echo/badge.png
9+
:target: https://crate.io/packages/pytest-echo/
10+
11+
12+
Print environment variables, package version and generic attributes.
13+
14+
Useful in the continuous integration to dump test configuration/environment.
715

816

917
Install
@@ -18,8 +26,9 @@ install via::
1826
The plugin provides ability to print some extra information prior to run the tests.
1927

2028

21-
Examples
22-
--------
29+
30+
Example
31+
-------
2332

2433
Dump environment variables
2534
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -56,11 +65,49 @@ Dump attributes
5665
DEBUG: False
5766
plugins: echo, pydev, cov, cache, django
5867
59-
.. warning:: Be careful when use ``--echo-attr``. It load any module in the path and this will
68+
.. warning:: Be careful when use ``--echo-attr``. It load any module in the path and this will
6069
execute any module's level code
70+
If you try to dump a property, related ``getter`` will be executed.
71+
72+
.. note:: You cannot dump callable result.
73+
6174

75+
Configure via tox.ini/setup.cfg/pytest.cfg
76+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6277

78+
Example of use in a django project:
6379

80+
.. code-block:: inifile
81+
82+
[pytest]
83+
--tb=short
84+
--capture=no
85+
--echo-env PWD
86+
--echo-env VIRTUAL_ENV
87+
--echo-env DBENGINE
88+
--echo-version django
89+
--echo-version pip
90+
--echo-version pytest_echo
91+
--echo-attr django.conf.settings.DATABASES.default.ENGINE
92+
93+
94+
95+
.. code-block:: sh
96+
97+
$ py.test
98+
============================= test session starts =========================
99+
platform linux2 -- Python 2.7.4 -- py-1.4.22 -- pytest-2.6.0 -- /bin/python
100+
Environment:
101+
DJANGO_SETTINGS_MODULE: tests.settings
102+
PWD: /data/PROGETTI/ONU_WorldFoodProgramme/wfp-auth
103+
VIRTUAL_ENV: /data/VENV/sem
104+
DBENGINE: <not set>
105+
Package version:
106+
django: 1.6.5
107+
pip: 1.5.6
108+
pytest_echo: 1.2
109+
Inspections:
110+
django.conf.settings.DATABASES.default.ENGINE: 'django.db.backends.postgresql_psycopg2'
64111
65112
Links
66113
~~~~~

‎docs/Makefile

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = _build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14+
# the i18n builder cannot share the environment and doctrees with the others
15+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16+
17+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18+
19+
help:
20+
@echo "Please use \`make <target>' where <target> is one of"
21+
@echo " html to make standalone HTML files"
22+
@echo " dirhtml to make HTML files named index.html in directories"
23+
@echo " singlehtml to make a single large HTML file"
24+
@echo " pickle to make pickle files"
25+
@echo " json to make JSON files"
26+
@echo " htmlhelp to make HTML files and a HTML help project"
27+
@echo " qthelp to make HTML files and a qthelp project"
28+
@echo " devhelp to make HTML files and a Devhelp project"
29+
@echo " epub to make an epub"
30+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
32+
@echo " text to make text files"
33+
@echo " man to make manual pages"
34+
@echo " texinfo to make Texinfo files"
35+
@echo " info to make Texinfo files and run them through makeinfo"
36+
@echo " gettext to make PO message catalogs"
37+
@echo " changes to make an overview of all changed/added/deprecated items"
38+
@echo " linkcheck to check all external links for integrity"
39+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
40+
41+
clean:
42+
-rm -rf $(BUILDDIR)/*
43+
44+
html:
45+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46+
@echo
47+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48+
49+
dirhtml:
50+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51+
@echo
52+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53+
54+
singlehtml:
55+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56+
@echo
57+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58+
59+
pickle:
60+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61+
@echo
62+
@echo "Build finished; now you can process the pickle files."
63+
64+
json:
65+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66+
@echo
67+
@echo "Build finished; now you can process the JSON files."
68+
69+
htmlhelp:
70+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71+
@echo
72+
@echo "Build finished; now you can run HTML Help Workshop with the" \
73+
".hhp project file in $(BUILDDIR)/htmlhelp."
74+
75+
qthelp:
76+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77+
@echo
78+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
79+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pytest-cache.qhcp"
81+
@echo "To view the help file:"
82+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pytest-cache.qhc"
83+
84+
devhelp:
85+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86+
@echo
87+
@echo "Build finished."
88+
@echo "To view the help file:"
89+
@echo "# mkdir -p $$HOME/.local/share/devhelp/pytest-cache"
90+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pytest-cache"
91+
@echo "# devhelp"
92+
93+
epub:
94+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95+
@echo
96+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97+
98+
latex:
99+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100+
@echo
101+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
103+
"(use \`make latexpdf' here to do that automatically)."
104+
105+
latexpdf:
106+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107+
@echo "Running LaTeX files through pdflatex..."
108+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
109+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110+
111+
text:
112+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113+
@echo
114+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
115+
116+
man:
117+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118+
@echo
119+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120+
121+
texinfo:
122+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123+
@echo
124+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125+
@echo "Run \`make' in that directory to run these through makeinfo" \
126+
"(use \`make info' here to do that automatically)."
127+
128+
info:
129+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130+
@echo "Running Texinfo files through makeinfo..."
131+
make -C $(BUILDDIR)/texinfo info
132+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133+
134+
gettext:
135+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136+
@echo
137+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138+
139+
changes:
140+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141+
@echo
142+
@echo "The overview file is in $(BUILDDIR)/changes."
143+
144+
linkcheck:
145+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146+
@echo
147+
@echo "Link check complete; look for any errors in the above output " \
148+
"or in $(BUILDDIR)/linkcheck/output.txt."
149+
150+
doctest:
151+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152+
@echo "Testing of doctests in the sources finished, look at the " \
153+
"results in $(BUILDDIR)/doctest/output.txt."

‎docs/api.rst

Whitespace-only changes.

‎docs/index.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,3 @@ Contents:
1313

1414
readme
1515

16-
17-
Indices and tables
18-
==================
19-
20-
* :ref:`genindex`
21-
* :ref:`modindex`
22-
* :ref:`search`
23-

‎pytest_echo.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from pprint import pformat
44

55

6-
__version__ = '1.2'
6+
__version__ = '1.3'
77

88

99
class RetrieveException(Exception):
@@ -88,6 +88,13 @@ def get_module_attribute(path):
8888

8989

9090
def _get_version(package_name):
91+
try:
92+
import pkg_resources
93+
94+
return pkg_resources.require(package_name)[0].version
95+
except:
96+
pass
97+
9198
try:
9299
pkg = __import__(package_name)
93100
except ImportError:

‎setup.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,19 @@
66
setup(
77
name='pytest-echo',
88
description='pytest plugin with mechanisms for echoing environment '
9-
'variables, package version and django settings',
9+
'variables, package version and generic attributes',
1010
long_description=open("README.rst").read(),
1111
version=__version__,
1212
author='Stefano Apostolico',
1313
author_email='[email protected]',
14-
url='http://bitbucket.org/hpk42/pytest-echo/',
14+
url='http://pypi.python.org/pypi/pytest-echo/',
1515
py_modules=['pytest_echo'],
1616
entry_points={'pytest11': ['echo = pytest_echo']},
1717
install_requires=['pytest>=2.2'],
1818
license="MIT License",
1919
classifiers=[
20-
'Development Status :: 3 - Alpha',
20+
'Development Status :: 5 - Production/Stable',
21+
'Environment :: Plugins',
2122
'Intended Audience :: Developers',
2223
'License :: OSI Approved :: MIT License',
2324
'Operating System :: POSIX',
@@ -28,5 +29,6 @@
2829
'Topic :: Utilities',
2930
'Programming Language :: Python',
3031
'Programming Language :: Python :: 2.7',
31-
'Programming Language :: Python :: 3.3'
32+
'Programming Language :: Python :: 3.3',
33+
'Programming Language :: Python :: 3.4',
3234
])

0 commit comments

Comments
 (0)