trustchain-oc1-orchestral
/
devicehub-teal
Archived
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix link readme (reviewed)

This commit is contained in:
RubenPX 2022-04-04 17:59:51 +02:00
parent c5f006d40f
commit 57e35c016f
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
readme.md
View File

@ -11,7 +11,7 @@ The requirements are:
- Python 3.7.3 or higher. In debian 10 is `# apt install python3`. - Python 3.7.3 or higher. In debian 10 is `# apt install python3`.
- [PostgreSQL 11 or higher](https://www.postgresql.org/download/). - [PostgreSQL 11 or higher](https://www.postgresql.org/download/).
- Weasyprint [dependencie](http://weasyprint.readthedocs.io/en/stable/install.html>) - Weasyprint [dependencie](http://weasyprint.readthedocs.io/en/stable/install.html)
Install Devicehub with *pip*: `pip3 install -U -r requirements.txt -e .` Install Devicehub with *pip*: `pip3 install -U -r requirements.txt -e .`
@ -20,8 +20,8 @@ Create a PostgreSQL database called *devicehub* by running [create-db](examples/
- In Linux, execute the following two commands (adapt them to your distro): - In Linux, execute the following two commands (adapt them to your distro):
1. ``sudo su - postgres``. 1. `sudo su - postgres`.
2. ``bash examples/create-db.sh devicehub dhub``, and password ``ereuse``. 2. `bash examples/create-db.sh devicehub dhub`, and password `ereuse`.
- In MacOS: `bash examples/create-db.sh devicehub dhub`, and password `ereuse`. - In MacOS: `bash examples/create-db.sh devicehub dhub`, and password `ereuse`.
@ -45,28 +45,22 @@ $ export dhi=dbtest;dh run --debugger
The error ‘bdist_wheel’ can happen when you work with a *virtual environment*. The error ‘bdist_wheel’ can happen when you work with a *virtual environment*.
To fix it, install in the *virtual environment* wheel To fix it, install in the *virtual environment* wheel
package. ``pip3 install wheel`` package. `pip3 install wheel`
## Multiple instances ## Multiple instances
Devicehub can run as a single inventory or with multiple inventories, Devicehub can run as a single inventory or with multiple inventories, each inventory being an instance of the `devicehub`. To add a new inventory execute:
each inventory being an instance of the ``devicehub``. To add a new inventory
execute:
```bash ```bash
$ export dhi=dbtest; dh inv add --name dbtest $ export dhi=dbtest; dh inv add --name dbtest
``` ```
Note: The ``dh`` command is like ``flask``, but it allows you to create and delete instances, and interface to them Note: The `dh` command is like `flask`, but it allows you to create and delete instances, and interface to them directly.
directly.
# Testing # Testing
1. `git clone` this project. 1. `git clone` this project.
2. Create a database for testing executing `create-db.sh` like the 2. Create a database for testing executing `create-db.sh` like the normal installation but changing the first parameter from `devicehub` to `dh_test`: `create-db.sh dh_test dhub` and password `ereuse`.
normal installation but changing the first parameter from
`devicehub` to `dh_test`: `create-db.sh dh_test dhub` and
password `ereuse`.
3. Execute at the root folder of the project `python3 setup.py test`. 3. Execute at the root folder of the project `python3 setup.py test`.