Skip to content
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

Jump to bottom

Update getting started doc. #255

Merged
merged 3 commits into from
Jul 30, 2020
Merged

Update getting started doc. #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef14451
Update getting started doc.
smarlowucf Jul 29, 2020
a05e860
Ensure latest pytest used in travis testing.
smarlowucf Jul 30, 2020
aaa4e06
Fix typo s/it's/its.
smarlowucf Jul 30, 2020
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
1 change: 1 addition & 0 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ python:
- "3.7"
install:
- pip install -e .[dev]
- pip install --upgrade pytest
script:
- pytest --cov=img_proof
- flake8 img_proof
Expand Down
11 changes: 6 additions & 5 deletions docs/source/start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,18 +81,19 @@ specific values.
To override the default configuration location the CLI option ``-C`` or
``--config`` is available.

The img_proof section is required. The cloud framework sections are optional and
would be [{cloud_framework}]. For example, the [ec2] section in the following
file.
The config file can have multiple sections. The default section is [img_proof]
and each cloud framework can have its own section such as [{cloud_framework}].
A config file with an [ec2] section may look like the following:

.. code-block:: ini

[img_proof]
tests=~/img_proof/tests/
results=~/img_proof/results/
test_dirs=/custom/tests/path/
results_dir=/custom/results/dir/

[ec2]
region=us-west-1
ssh_private_key_file = ~/.ssh/id_rsa

There are multiple ways to provide configuration values when using
**img-proof**. All options are available via command line and the configuration
Expand Down