API that search tools and retrieve the common articles where these tools have been cited.
Python 3.5 or later is needed. The script depends on standard libraries, plus the ones declared in requirements.txt.
-
In order to install the dependencies you need
pip
andvenv
Python modules.pip
is available in many Linux distributions (Ubuntu packagepython-pip
, CentOS EPEL packagepython-pip
), and also as pip Python package.venv
is also available in many Linux distributions (Ubuntu packagepython3-venv
). In some of these distributionsvenv
is integrated into the Python 3.5 (or later) installation.
-
The creation of a virtual environment and installation of the dependencies in that environment is done running:
python3 -m venv env
source env/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
wget https://zenodo.org/api/records/10666656/files/databaseReverse.db.gz/content -O databaseReverse.db.gz
gunzip databaseReverse.db.gz
Also, you can create manually the database in createDataset
Run the script:
python3 main.py -d databaseReverse.db
Then, go to localhost:5000 and you can do the two following queries:
- List all the tools available in the database (limit default 10 and skip default is 0):
localhost:5000/listTools
localhost:5000/listTools?limit=10&skip=0
- Search common articles where tools are referenced:
localhost:5000/search
localhost:5000/search?tool=ps2&tool=ps2-v3&tool=3d-pssm