::
=============================================================
entify Copyright (C) 2014 F. Brezo and Y. Rubio, i3visio
=============================================================
Description:
============
entify is a GPLv3+ piece of software that looks for regular expressions
in a series of files in a folder. It can also be imported by other
modules to look for entities in any kind of data.
License: GPLv3+
===============
This is free software, and you are welcome to redistribute it under
certain conditions.
::
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
For more details on this issue, run:
``python entify-launcher.py --license``
Installation:
=============
The instructions may vary in the different OS.
Under Linux
-----------
We recommend you to create a folder under /var owned by the current
user. For instance:
``# You will need superuser privileges to create this folder sudo mkdir /var/i3visio # You will need to change the owner to your user to work with it safely # If your user was alice sudo chown alice:alice /var/i3visio``
The rest of the installation under Python 2.7 is as follows:
``# Navigate to the destiny's folder cd /var/i3visio # Cloning the repository git clone http://github.com/i3visio/entify entify-master cd entify-master``
or
``# Navigate to the destiny's folder cd /var/i3visio # Download wget http://github.com/i3visio/entify/archive/master.zip # Unzip unzip entify-master.zip cd entify-master``
Then you can proceed to the installation.
``# Superuser privileges are required so as to complete the installation. sudo python setup.py build sudo python setup.py install``
Afterwards, the module will be importable from any python code. You can
check this by typing: ``python -c "import entify"`` If no error is
displayed, the installation would have been performed correctly.
Usage:
======
So as to run the program, navigate to entify-master/entify/ and run:
``python entify-launcher.py -h`` The usage is described as follows:
``usage: entify.py (-r <name> [<name> ...] | -R <regular_expression> [<regular_expression> ...]) [-e <sum_ext> [<sum_ext> ...]] -f <path_to_input_folder> [-o <path_to_output_folder>] [--recursive] [-v <verbosity>] [-h] [--version]``
The functionalities are described as follows: \`\`\` Input options (one
required): -r [ ...], --regexp [ ...] select the regular expressions to
be looked for amongst the following: ['all', 'email', 'md5'] -R [ ...],
--new\_regexp [ ...] add a new regular expression, for example, for
testing purposes.
Input and output arguments: Configuring the input and output options.
-e [ ...], --extension [ ...] output extension for the summary files (at
least one is required). -i , --input\_folder path to the file where the
list of Classes is stored (one per line). -o , --output\_folder path to
the output folder where the results will be stored. --recursive Variable
to tell the system to perform a recursive search on the folder tree. -v
, --verbose select the verbosity level: 0 - none; 1 - normal (default);
2 - debug.
About arguments: Showing additional information about this program.
-h, --help shows this help and exists. --version shows the version of
the program and exists. \`\`\`