-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
528fdbe
commit 007789e
Showing
7 changed files
with
73 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,3 +7,5 @@ venv | |
.pytest_cache | ||
*.pyc | ||
.DS_Store | ||
dist | ||
build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,11 +28,16 @@ python3 -m virtualenv $PATH_TO_VENV | |
source $PATH_TO_VENV/bin/activate | ||
``` | ||
|
||
In order to install the utility, run | ||
The simplest way of installing `webviz-config` is to run | ||
```bash | ||
pip install webviz-config | ||
``` | ||
|
||
If you want to download the latest source code and install it manually you | ||
can run | ||
```bash | ||
git clone [email protected]:equinor/webviz-config.git | ||
cd webviz-config | ||
pip install -r requirements.txt | ||
pip install . | ||
``` | ||
### Run tests | ||
|
@@ -41,14 +46,14 @@ To run tests it is necessary to first install [selenium chrome driver](https://g | |
Then install dev requirements and run pytest: | ||
|
||
```bash | ||
pip install -r dev_requirements.txt | ||
pip install .[tests] | ||
pytest tests | ||
``` | ||
|
||
Linting can be checked by: | ||
|
||
```bash | ||
pycodestyle webviz_config/ tests/ | ||
pycodestyle webviz_config tests | ||
``` | ||
|
||
### Build documentation | ||
|
@@ -57,7 +62,7 @@ End-user documentation (i.e. YAML configuration file) be created | |
after installation by | ||
|
||
```bash | ||
pip install -r dev_requirements.txt | ||
pip install .[tests] | ||
cd ./docs | ||
python3 build_docs.py | ||
``` | ||
|
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
from pkg_resources import get_distribution, DistributionNotFound | ||
|
||
try: | ||
__version__ = get_distribution(__name__).version | ||
except DistributionNotFound: | ||
# package is not installed | ||
pass |