Enhance installation
This commit is contained in:
parent
0c29497179
commit
c9639a5eb8
28
README.md
28
README.md
|
@ -29,22 +29,14 @@ The requirements are:
|
||||||
Install Devicehub with *pip*: `pip3 install ereuse-devicehub -U --pre`.
|
Install Devicehub with *pip*: `pip3 install ereuse-devicehub -U --pre`.
|
||||||
|
|
||||||
## Running
|
## Running
|
||||||
Download, or copy the contents, of [this file](example/app.py), and
|
Download, or copy the contents, of [this file](examples/app.py), and
|
||||||
call the new file ``app.py``.
|
call the new file ``app.py``.
|
||||||
|
|
||||||
Create a PostgreSQL database called *devicehub*:
|
Create a PostgreSQL database called *devicehub* by running
|
||||||
|
[create-db](examples/create-db.sh):
|
||||||
|
|
||||||
```bash
|
- In Debian 9: `sudo su - postgres; examples/create-db.sh devicehub`
|
||||||
sudo su - postgres # Change to Postgres main user
|
- In MacOS: `examples/create-db.sh devicehub`.
|
||||||
postgres $ createdb devicehub # Create main database
|
|
||||||
postgres $ psql devicehub # Access to the database
|
|
||||||
postgres $ CREATE USER dhub WITH PASSWORD 'ereuse'; # Create user devicehub uses to access db
|
|
||||||
postgres $ GRANT ALL PRIVILEGES ON DATABASE devicehub TO dhub; # Give access to the db
|
|
||||||
postgres $ CREATE EXTENSION pgcrypto SCHEMA public; # Enable pgcrypto
|
|
||||||
postgres $ CREATE EXTENSION ltree SCHEMA public; # Enable ltree
|
|
||||||
postgres $ \q
|
|
||||||
exit
|
|
||||||
```
|
|
||||||
|
|
||||||
Create the tables in the database by executing in the same directory
|
Create the tables in the database by executing in the same directory
|
||||||
where `app.py` is:
|
where `app.py` is:
|
||||||
|
@ -89,13 +81,9 @@ Use postman as an example of how to use the API.
|
||||||
To run the tests you will need to:
|
To run the tests you will need to:
|
||||||
|
|
||||||
1. `git clone` this project.
|
1. `git clone` this project.
|
||||||
2. Create a database for testing. By default the database used is
|
2. Create a database for testing executing `create-db.sh` like
|
||||||
`dh_test`. Execute to create it:
|
the normal installation but changing the first parameter
|
||||||
1. `postgres $ createdb dh_test`.
|
from `devicehub` to `dh_test`: `create-db.sh dh_test`.
|
||||||
2. `postgres $ psql dh_test`.
|
|
||||||
3. `postgres $ GRANT ALL PRIVILEGES ON DATABASE dh_test TO dhub;`.
|
|
||||||
4. `CREATE EXTENSION pgcrypto SCHEMA public;`
|
|
||||||
5. `CREATE EXTENSION ltree SCHEMA public;`
|
|
||||||
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`.
|
||||||
|
|
||||||
## Generating the docs
|
## Generating the docs
|
||||||
|
|
8
examples/create-db.sh
Normal file
8
examples/create-db.sh
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
# Creates a database, user, and extensions to use Devicehub
|
||||||
|
|
||||||
|
createdb $1 # Create main database
|
||||||
|
psql -d $1 -c "CREATE USER dhub WITH PASSWORD 'ereuse';" # Create user devicehub uses to access db
|
||||||
|
psql -d $1 -c "GRANT ALL PRIVILEGES ON DATABASE devicehub TO dhub;" # Give access to the db
|
||||||
|
psql -d $1 -c "CREATE EXTENSION pgcrypto SCHEMA public;" # Enable pgcrypto
|
||||||
|
psql -d $1 -c "CREATE EXTENSION ltree SCHEMA public;" # Enable ltree
|
Reference in a new issue