Skip to content

PyATS configuration environment variable usage #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dwapstra wants to merge 1 commit into
base: main
Choose a base branch
from
Open

PyATS configuration environment variable usage #285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/configuration/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,18 @@ Each INI file content is standardized to use:
- ``=`` as key/value delimiter
- ``#`` for comments.

INI values also support environment variable expansion via standard shell-style
references such as ``$VAR`` and ``${VAR}``.

.. code-block:: ini

[easypy]
runinfo.directory = $HOME/work/pyats/runinfo
runinfo.archive = $ARCHIVE_ROOT/pyats

If an environment variable referenced in ``pyats.conf`` is not set, pyATS logs
a warning and substitutes an empty string.

.. note::

do not use quotes around strings in INI files - see
Expand Down