aljaz/python-teos
1
0
Fork 0
mirror of https://github.com/aljazceru/python-teos.git synced 2025-12-17 22:24:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Adds module info to INSTALL docs

Browse Source
This commit is contained in:
Sergi Delgado Segura
2020-02-13 13:35:02 +01:00
parent e6187fc657
commit a655eb8b98
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
apps/cli/INSTALL.md
View File

@@ -2,6 +2,9 @@
`wt_cli` has some dependencies that can be satisfied by following [DEPENDENCIES.md](DEPENDENCIES.md). If your system already satisfies the dependencies, you can skip that part.
There are two ways of running `wt_cli`: adding the library to the `PYTHONPATH` env variable, or running it as a module
## Modifying `PYTHONPATH`
In order to run `wt_cli`, you should set your `PYTHONPATH` env variable to include the folder that contains the `apps` folder. You can do so by running:
export PYTHONPATH=$PYTHONPATH:<absolute_path_to_apps>
@@ -17,4 +20,11 @@ You should also include the command in your `.bash_rc` to avoid having to run it
Once the `PYTHONPATH` is set, you should be able to run `wt_cli` straightaway. Try it by running:
cd <absolute_path_to_apps>/apps/cli
python wt_cli.py -h
python wt_cli.py -h
## Running `wt_cli` as a module
Python code can be also run as a module, to do you need to use `python -m`. From `apps` **parent** directory run:
python -m apps.cli.wt_cli -h
Notice that if you run `wt_cli` as a module, you'll need to replace all the calls to `python wt_cli.py <argument>` to `python -m apps.cli.wt_cli <argument>`