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

Updates repo name to not match server-side name. Updates INSTALL

Browse Source
This commit is contained in:
Sergi Delgado Segura
2020-03-18 17:08:40 +01:00
parent b200968da9
commit 685c81fa40
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
INSTALL.md
View File

@@ -5,25 +5,25 @@
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`: adding the library to the `PYTHONPATH` env variable, or running it as a module.
## Modifying `PYTHONPATH` ## Modifying `PYTHONPATH`
In order to run `teos`, you should set your `PYTHONPATH` env variable to include the **outer** teos folder. You can do so by running: 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> 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: For example, for user alice running a UNIX system and having `teos` in her home folder, she would run:
export PYTHONPATH=$PYTHONPATH:/home/alice/teos/ 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: 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>' >> ~/.bashrc 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: Once the `PYTHONPATH` is set, you should be able to run `teos` straightaway. Try it by running:
cd <absolute_path_to_teos>/teos/ cd <absolute_path_to_teos_parent>/teos/
python teosd.py python teosd.py
## Running `teos` as a module ## 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 **outer** teos directory run: Python code can be also run as a module, to do so you need to use `python -m`. From the teos parent directory run:
python -m teos.teosd python -m teos.teosd
@@ -32,4 +32,4 @@ Notice that if you run `teos` as a module, you'll need to replace all the calls
## Modify configuration parameters ## 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: 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>/teos/conf.py <absolute_path_to_teos_parent>/teos/conf.py