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

Improves docs

Browse Source
This commit is contained in:
Sergi Delgado Segura
2020-03-18 20:13:50 +01:00
parent 9d08c10416
commit 89708e86b3
4 changed files with 50 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
INSTALL.md
View File

@@ -2,34 +2,29 @@
`teos` 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 `teos`: adding the library to the `PYTHONPATH` env variable, or running it as a module.
There are two ways of running `teos`: running it as a module or adding the library to the `PYTHONPATH` env variable.
## Modifying `PYTHONPATH`
In order to run `teos`, you should set your `PYTHONPATH` env variable to include the teos parent folder. You can do so by running:
export PYTHONPATH=$PYTHONPATH:<absolute_path_to_teos_parent>
For example, for user alice running a UNIX system and having `teos` in her home folder, she would run:
export PYTHONPATH=$PYTHONPATH:/home/alice/
You should also include the command in your `.bashrc` to avoid having to run it every time you open a new terminal. You can do it by running:
echo 'export PYTHONPATH=$PYTHONPATH:<absolute_path_to_teos_parent>' >> ~/.bashrc
Once the `PYTHONPATH` is set, you should be able to run `teos` straightaway. Try it by running:
cd <absolute_path_to_teos_parent>/teos/
python teosd.py
## Running `teos` as a module
Python code can be also run as a module, to do so you need to use `python -m`. From the teos parent directory run:
## Running `teos` as a Module
The easiest way to run `teos` is as a module. To do so you need to use `python -m`. From the teos parent directory run:
python -m teos.teosd
Notice that if you run `teos` as a module, you'll need to replace all the calls from `python teosd.py` to `python -m teos.teosd`
## Modify configuration parameters
## Modifying `PYTHONPATH`
Alternatively, you can add `teos` to your `PYTHONPATH`. You can do so by running:
export PYTHONPATH=$PYTHONPATH:<absolute_path_to_teos_parent>
For example, for user alice running a UNIX system and having `python-teos` in her home folder, she would run:
export PYTHONPATH=$PYTHONPATH:/home/alice/python-teos/
You should also include the command in your `.bashrc` to avoid having to run it every time you open a new terminal. You can do it by running:
echo 'export PYTHONPATH=$PYTHONPATH:<absolute_path_to_teos_parent>' >> ~/.bashrc
## Modify Configuration Parameters
If you'd like to modify some of the configuration defaults (such as the user directory, where the logs will be stored) you can do so in the config file located at:
<absolute_path_to_teos_parent>/teos/conf.py