Devicehub

Devicehub is an IT Asset Management System focused in reusing devices, created under the project eReuse.org.

Our main objectives are:

• To offer a common IT Asset Management for donors, receivers and IT professionals so they can manage devices and exchange them. This is, reusing –and ultimately recycling.
• To automatically recollect, analyse, process and share (controlling privacy) metadata about devices with other tools of the eReuse ecosystem to guarantee traceability, and to provide inputs for the indicators which measure circularity.
• To highly integrate with existing IT Asset Management Systems.
• To be decentralized.

Devicehub is built with Teal and Flask.

Installing

The requirements are:

• Python 3.5.3 or higher. In debian 9 is # apt install python3-pip.
• PostgreSQL 9.6 or higher with pgcrypto and ltree. In debian 9 is # apt install postgresql-contrib
• passlib. In debian 9 is # apt install python3-passlib.

Install Devicehub with pip: pip3 install ereuse-devicehub -U --pre.

Running

Download, or copy the contents, of this file, and call the new file app.py.

Create a PostgreSQL database called devicehub by running create-db:

• In a Debian 9 terminal, execute the following two commands:
  1. sudo su - postgres.
  2. bash examples/create-db.sh devicehub.
• In MacOS: examples/create-db.sh devicehub.

Create the tables in the database by executing in the same directory where app.py is:

$ flask init-db

Finally, run the app:

$ flask run

The error flask: command not found can happen when you are not in a virtual environment. Try executing then python3 -m flask.

See the Flask quickstart for more info.

Administrating

Devicehub has many commands that allows you to administrate it. You can, for example, create a dummy database of devices with flask dummy or create users with flask create-user. See all the available commands by just executing flask and get more information per command by executing flask command --help.

Understand the software

See the docs to understand how the software works and the design principles.

Use the API

Checkout Swagger to see the schemas and endpoints (we are working in making it interactive).

Use postman as an example of how to use the API.

Testing

To run the tests you will need to:

1. git clone this project.
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.
3. Execute at the root folder of the project python3 setup.py test.

Generating the docs

1. git clone this project.
2. Install plantuml. In Debian 9 is # apt install plantuml.
3. Execute pip3 install -e .[docs] in the project root folder.
4. Go to <project root folder>/docs and execute make html. Repeat this step to generate new docs.