tox_backtick documentation¶
tox-backtick¶
Backticks tox plugin for tox v.4.x.x.
Overview¶
tox-backtick is a strict fork of Damien Nadé’s tox-backtocks package (v.0.4.0) with a fixes allowing to work on Python 3.8 or higher and on Windows with a little code reformatting and minor improvements.
Overview below is a copy from the original tox-backtocks README.md:
tox-backtocks¶
A refreshed backticks tox plugin
This is a very early stage release. Use it at your own risks.
Here’s the roadmap to 1.0 release and our current status:
- [x] define a
backquote varinset_envwith a backquoted expression(and nothing else) and evaluate it through bash, inside the tox virtual environment.
- [x] define a
[x] Make of a
backquote varusable in commands section.- [x] Allow another variable to be referenced inside the
backquoted expression
- [x] Strip the trailing newline characters of the
backquoted expression
- [ ] Allow user configure the evaluation of
backquote expression to be with a shell or not (either fork the command directly, either fork a shell and evaluate a possible-complex shell expression)
- [ ] Allow user configure the evaluation of
- [ ] Allow a
backquote varvalue to contain regular string parts and a
backquote expression
- [ ] Allow a
- [ ] Allow a
backquote varvalue to contain more than one backquote expression
- [ ] Allow a
- [ ] Allow user to configure if we should strip the trailing newline
characters or not.
- [x] Allow another variable to reuse the evaluated
backquoted expression
- [x] Allow another variable to reuse the evaluated
backquoted expressionwithout reevaluating it :) (I mean, it’s hacked, but heh, better than nothing)
- [x] If evaluating through a shell, automatically add said shell to
allowlist_externalssection
- [x] Use the command string as is if 1st character in the command string
is the + char (immediately after initial backtick). Bypasses the use of shlex.split() before handing off to tox_env.execute().
[x] Have a working package
[ ] Write user documentation
Usage¶
TBD…
Installation¶
Prerequisites:
Python 3.10 or higher
pip
To install run:
python -m pip install --upgrade tox-backtick
Development¶
Prerequisites:
Development is strictly based on nox. To install it run:
python -m pip install --upgrade nox
Visit Development page.
Installation from sources:
clone the sources:
git clone https://github.com/karpierz/tox-backtick tox-backtick
and run:
python -m pip install ./tox-backtick
or on development mode:
python -m pip install --editable ./tox-backtick
License¶
Copyright (c) 2024-2026 Adam KarpierzCopyright (c) 2023 Damien NadéCopyright (c) 2025 Steve HespeltLicensed under the LGPL-2.1-or-later LicensePlease refer to the accompanying LICENSE file.