Metadata-Version: 2.1
Name: scrapd
Version: 1.0.0
Summary: Extract data from APD news site
Home-page: http://www.scrapd.org/
Author: rgreinho
Author-email: remy.greinhofer@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: aiohttp (==3.5.4)
Requires-Dist: anyconfig (==0.9.8)
Requires-Dist: click (==7.0)
Requires-Dist: dateparser (==0.7.0)
Requires-Dist: loguru (==0.2.4)
Requires-Dist: lxml (==4.3.0)
Requires-Dist: pbr (==5.1.1)
Requires-Dist: tabulate (==0.8.2)

ScrAPD
======

Extract data from APD news site.

ScrAPD is a small utility designed to help organizations retrieving traffic fatality data in a friendly manner.

Installation
------------

ScrAPD requires Python 3.7+ to work.

::

  pip install scrapd

Quickstart
----------
Collect all the data as CSV::

  scrapd retrieve --format csv

By default, scrapd does not display anything until it is done collecting the data. If you want to get some feedback
about the process, you can enable logging, by adding the `-v` **BEFORE** the command you want to use. Multiple `-v`
options increase the verbosity. The maximum is 3 (`-vvv`)::

  scrapd -v retrieve --format csv

To save the results to a file, use the shell redirection::

  scrapd -v retrieve --format csv > results.csv

.. note::

  The logs are displayed to `stderr` and will not appear in the result file generated by the redirection. If you want to
  include this information add  `&2>1`.

Examples
^^^^^^^^

Retrieve the traffic fatalities that happened between January 15th 2019 and January 18th 2019, and output the results
in `json`::

  scrapd retrieve --from "Jan 15 2019" --to "Jan 18 2019" --format json

  [
    {
      "Age": 31,
      "Case": "19-0150158",
      "DOB": "07/09/1987",
      "Date": "January 15, 2019",
      "Ethnicity": "White",
      "Fatal crashes this year": "1",
      "First Name": "Hilburn",
      "Gender": "male",
      "Last Name": "Sell",
      "Link": "http://austintexas.gov/news/traffic-fatality-1-4",
      "Location": "10500 block of N IH 35 SB",
      "Time": "6:20 a.m."
    },
    {
      "Age": 58,
      "Case": "19-0161105",
      "DOB": "02/15/1960",
      "Date": "January 16, 2019",
      "Ethnicity": "White",
      "Fatal crashes this year": "2",
      "First Name": "Ann",
      "Gender": "female",
      "Last Name": "Bottenfield-Seago",
      "Link": "http://austintexas.gov/news/traffic-fatality-2-3",
      "Location": "West William Cannon Drive and Ridge Oak Road",
      "Time": "3:42 p.m."
    }
  ]

Do the same research but output as CSV::

    scrapd retrieve --from "Jan 15 2019" --to "Jan 18 2019" --format csv


    Fatal crashes this year,Case,Date,Time,Location,First Name,Last Name,Ethnicity,Gender,DOB,Age,Link
    1,19-0150158,"January 15, 2019",6:20 a.m.,10500 block of N IH 35 SB,Hilburn,Sell,White,male,07/09/1987,31,http://austintexas.gov/news/traffic-fatality-1-4
    2,19-0161105,"January 16, 2019",3:42 p.m.,West William Cannon Drive and Ridge Oak Road,Ann,Bottenfield-Seago,White,female,02/15/1960,58,http://austintexas.gov/news/traffic-fatality-2-3

Retrieve all the traffic fatalities from 2019 (*as of Jan 20th 2019*) in json, and enabling the logging to follow the progress
of the process::

  scrapd -v retrieve --from 2019 --format json

  Fetching page 1...
  Fetching page 2...
  Total: 2
  [
    {
      "Age": 31,
      "Case": "19-0150158",
      "DOB": "07/09/1987",
      "Date": "January 15, 2019",
      "Ethnicity": "White",
      "Fatal crashes this year": "1",
      "First Name": "Hilburn",
      "Gender": "male",
      "Last Name": "Sell",
      "Link": "http://austintexas.gov/news/traffic-fatality-1-4",
      "Location": "10500 block of N IH 35 SB",
      "Time": "6:20 a.m."
    },
    {
      "Age": 58,
      "Case": "19-0161105",
      "DOB": "02/15/1960",
      "Date": "January 16, 2019",
      "Ethnicity": "White",
      "Fatal crashes this year": "2",
      "First Name": "Ann",
      "Gender": "female",
      "Last Name": "Bottenfield-Seago",
      "Link": "http://austintexas.gov/news/traffic-fatality-2-3",
      "Location": "West William Cannon Drive and Ridge Oak Road",
      "Time": "3:42 p.m."
    }
  ]



