Giter VIP home page Giter VIP logo

tox-envreport's Introduction

tox-envreport

PyPI version Python versions See Build Status on Travis CI

tox-envreport is a plugin for tox to document the setup of used virtual environments.

Collected information are stored in a file called env_report.json inside the .tox folder. For example: MY_PROJECT/.tox/env_report.json.

Documentation: https://tox-envreport.readthedocs.io/en/latest/

Installation

pip install tox-envreport

Usage

The installation of the plugin is enough to automatically activate it for each tox run.

There is nothing more to do or to configure.

Access reports

tox-envreport creates one common env_report.json file, which contains all information about all used virtual environments (venv) by tox.

Beside this a venv specific file is generated as well and contains information about the related venv only. You can find this file in the venv-specific tox-folder. E.g: MY_PROJECT/.tox/py27/env_report_py27.json for a venv called py27.

The report file itself contains the venv-name as postfix. E.g.: env_report_py27.json.

tox-envreport's People

Contributors

danwos avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar

tox-envreport's Issues

Include tests in sdist

Please include the tests in the sdist uploaded to PyPI, to help with distro packaging, and also creating a GitHub tag as part of each release would be helpful.

tox 4 compatiblity

This information can be extracted from --result-json. The only thing not enabled by default is running automatically.

Plugin broken with Tox >= 3.8.0

The plugin is broken with Tox >= 3.8.0:

Traceback (most recent call last):
  ...
  File ".../venvs/tox/lib/python3.6/site-packages/pluggy/hooks.py", line 289, in __call__
    return self._hookexec(self, self.get_hookimpls(), kwargs)
  File ".../venvs/tox/lib/python3.6/site-packages/pluggy/manager.py", line 68, in _hookexec
    return self._inner_hookexec(hook, methods, kwargs)
  File ".../venvs/tox/lib/python3.6/site-packages/pluggy/manager.py", line 62, in <lambda>
    firstresult=hook.spec.opts.get("firstresult") if hook.spec else False,
  File ".../venvs/tox/lib/python3.6/site-packages/pluggy/callers.py", line 208, in _multicall
    return outcome.get_result()
  File ".../venvs/tox/lib/python3.6/site-packages/pluggy/callers.py", line 80, in get_result
    raise ex[1].with_traceback(ex[2])
  File ".../venvs/tox/lib/python3.6/site-packages/pluggy/callers.py", line 187, in _multicall
    res = hook_impl.function(*args)
  File ".../venvs/tox/lib/python3.6/site-packages/tox_envreport/plugin.py", line 26, in tox_runtest_post
    tox_workdir = venv.session.config.toxworkdir.strpath
AttributeError: 'VirtualEnv' object has no attribute 'session'

This is the same problem reported by several other projects:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.