refactors project structure

This commit is contained in:
Sergi Delgado Segura
2019-08-09 19:42:42 +01:00
parent 1019b207ff
commit 1cde4a2a11
31 changed files with 31 additions and 29 deletions

20
apps/cli/INSTALL.md Normal file
View File

@@ -0,0 +1,20 @@
# Install
`pisa-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.
In order to run `pisa-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>
For example, for user alice running a UNIX system and having `apps` in her home folder, she would run:
export PYTHONPATH=$PYTHONPATH:/home/alice/
You should also include the command in your `.bash_rc` 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_apps>' >> ~/.bash_rc
Once the `PYTHONPATH` is set, you should be able to run `pisa-cli` straightaway. Try it by running:
cd <absolute_path_to_apps>/apps/cli
python pisa-cli.py -h