Uso

Serveliza puede usarse de distintas maneras.

Uso de línea de comandos

Si se corre desde la línea de comandos puedes acceder a ayuda de como usarlo.

$ serveliza -h

usage: serveliza [-h] [-v] {roll} ...

Serveliza is an application to extract data of the Chilean Electoral Service
(SERVEL) from different sources.

optional arguments:
  -h, --help     show this help message and exit
  -v, --version  show program's version number and exit

sub-commands:
  Serveliza has different utilities to extract data which are accessed
  through its subcommand. For more information check the help of each one.

  {roll}         description:
    roll         The roll command allows the extraction of electoral roll data
                 from pdf files to csv files.

Made with ♥ by @chivke.

También para cada uno de sus subcomandos disponibles.

$ serveliza roll -h
usage: serveliza roll [-h] [-o output] [-p {pdftotext,pdfminersix}]
                      [-m {unified,separated}] [-s {commune,region}] [-r]
                      [--no-suffix] [--no-summary] [--silent] [--no-colors]
                      [source [source ...]]

Serveliza is an application to extract data of the Chilean Electoral Service
(SERVEL) from different sources. The roll command allows the extraction of
electoral roll data from pdf files to csv files.

positional arguments:
  source                Directory(ies) or file(s) to search for valid
                        electoral rolls.

optional arguments:
  -h, --help            show this help message and exit
  -o output, --output output
                        Directory to store the data in .csv.
  -p {pdftotext,pdfminersix}, --processor {pdftotext,pdfminersix}
                        Processor (library) to extract text from pdf file.
  -m {unified,separated}, --mode {unified,separated}
                        'Determines the data export mode in files. If it is
                        "unified" (default) it creates a single csv file with
                        the data, or if it is "separated" into several
                        according to communal or regional criteria.'
  -s {commune,region}, --separator {commune,region}
                        Criteria for separating files in export in separate
                        mode.
  -r, --recursive       Property that determines if the search for pdf files
                        in the delivered source is recursive or is only for
                        the root of the indicated directory,
  --no-suffix           Determines whether exported files have a random text
                        string appended to the end.
  --no-summary          Determines whether to generate a summary file of the
                        export and the extracted data.
  --silent              Does not print application progress on screen.
  --no-colors           Does not colorize screen prints.

Made with ♥ by @chivke.

Uso programático

Puede usar los componentes de serveliza importándolos como subpaquetes como serveliza.roll, serveliza.utils o serveliza.mixins.

Por ejemplo, si puedes importar la clase principal que trabaja con padrones electorales.

from serveliza.roll import ElectoralRoll

También puede ser importada en forma abreviada, definida en el archivo __init__.py.

from serveliza.roll import ER

Dentro de serveliza, el módulo del mismo nombre define funciones para acceso rápido a diferentes acciones, instanciando las clases en forma transparente. La interfaz de línea de comandos funciona a través de estas funciones.

Por ejemplo, puedes obtener un objecto dataframe de pandas a través de la función:

from serveliza import serveliza
data = serveliza.roll_from_pdf_to_dataframe('.')

Esto de otra manera sería así:

from serveliza.roll import ElectoralRoll
roll = ElectoralRoll('.')
roll.run()
data = roll.roll_from_pdf_to_dataframe('.')