README.md

humans.db

This collection of tools allows you to create a little database with some information "offered" by EINA.

Installation

From source

You can do a manual installation with:

git clone https://github.com/wynro/humans.git
cd humans
sudo make install
sudo make install-doc # Optional, but gives documentation (man)

And a removal with:

git clone https://github.com/wynro/humans.git
cd humans
sudo make uninstall
sudo make install-doc # Optional, if you installed documentation

In both cases, remember to install/uninstall the required dependencies (Subsection Dependencies)

From packages

Go to the releases list (https://github.com/wynro/humans/releases), and download the desired package. You can easily install the package with:

sudo dpkg -i humans_*_all.deb

And remove it with:

sudo dpkg -r humans

In both cases, remember to install/uninstall the required dependencies (Subsection Dependencies)

Dependencies

Either if you install from sources o from package, you need to install all the required dependencies manually. Neither dpkg nor make install the dependencies.

The current dependencies arecoreutils, python, pdfgrep, sqlite3, curl, openssh-client, sed, grep, bsdmainutils, libc-bin and file. You should have most of those installed in any typical Debian/Ubuntu installation. In case you miss some of them, simply do:

sudo apt-get update
sudo apt-get install -y coreutils python pdfgrep sqlite3 curl openssh-client sed grep bsdmainutils libc-bin file

To install the missing dependencies. Make sure that the correct versions are being installed (Look in the file debian/control, line Depends: to see the required versions)

Remember to also remove any unnecessary package on uninstall.

Basic usage

This is a basic guide, the man pages are guaranteed to be more up-to-date, so I recommend to refer to them for detailed/extended/current information

Build the database

Standard build

After the installation (Section Installation) of the program, you have to create the database (an example one comes with the package, but it is empty and only includes the schema).

First, you need to download the information from the sources and save it in local plain text files, for that, execute:

humans-get-sources

That will create a bunch of files in /tmp/humans. Those files contain the information in plain text, but we need to compile them into a structured database, to simplify doing queries to the information. For that, just do:

humans-load

This will create a humans.db file in your current directory. Move it to its correct location with:

sudo mv humans.db /usr/share/humans/humans.db

Building with Docker

humans also supports using docker to create the database. To do so, clone the repository

git clone https://github.com/wynro/humans.git

Then, build the image

cd humans
docker build . --tag humans

Finally, execute it with

docker run --name humans -it -v /tmp:/result humans

With this configuration, the database will be left at /tmp, remember to move it to its correct location. With a standard installation, the command should be:

sudo mv /tmp/humans.db /usr/share/humans/humans.db

You can also change the final location of the database changing the ''/tmp'' part in the docker command (Check permissions).

After that, you can delete the created container and image to save space with

docker rm humans
docker rmi humans

Usage

The basic command is humans. It includes a beautifully made manual (in man humans) and Tab-completion, so feel free to explore all its possibilities by yourself.

Have fun!