skip to navigation
skip to content

Not Logged In

scraperwiki 0.3.8

Local version of ScraperWiki libraries

Latest Version: 0.4.1

ScraperWiki Python library



[![Build Status]https://travis-ci.org/scraperwiki/scraperwiki-python.png]https://travis-ci.org/scraperwiki/scraperwiki-python

This is a Python library for scraping web pages and saving data.
It is the easiest way to save data on the ScraperWiki platform, and it
can also be used locally or on your own servers.



Installing



pip install scraperwiki

Scraping




scraperwiki.scrape(url[, params][,user_agent])

Returns the downloaded string from the given url.


<var>params</var> are sent as a POST if set.


<var>user_agent</var> sets the user-agent string if provided.






Saving data



Helper functions for saving and querying an SQL database. Updates
the schema automatically according to the data you save.



Currently only supports SQLite. It will make a local SQLite database.
It is based on the Python module dumptruck. You should expect it to support
other SQL databases at a later date.




scraperwiki.sql.save(unique_keys, data[, table_name="swdata"])

Saves a data record into the datastore into the table given
by <var>table_name</var>.


<var>data</var> is a dict object with field names as keys;
<var>unique_keys</var> is a subset
of data.keys() which determines when a record is
overwritten.


For large numbers of records <var>data</var> can be a list of dicts.




scraperwiki.sql.execute(sql[, vars])

Executes any arbitrary SQL command. For
example CREATE, DELETE, INSERT or drop.


<var>vars</var> is an optional list of parameters, inserted when
the SQL command contains ‘?’s.
For example:


scraperwiki.sql.execute("INSERT INTO swdata VALUES (?,?,?)", [a,b,c])

The ‘?’ convention is like "paramstyle qmark"
from Python's
DB API 2.0
(but note that the API to the datastore is
nothing like Python's DB API). In particular the
‘?’ does not itself need quoting, and can in
general only be used where a literal would appear.




scraperwiki.sql.select(sqlfrag[, vars])

Executes a select command on the datastore. For example:


scraperwiki.sql.select("* FROM swdata LIMIT 10")

Returns a list of dicts that have been selected.


<var>vars</var> is an optional list of parameters, inserted when the
select command contains ‘?’s. This is like the
feature in the <var>.execute</var> command, above.




scraperwiki.sql.commit()

Commits to the file after a series of execute commands. (sql.save auto-commits after every action).


scraperwiki.sql.show_tables([dbname])

Returns an array of tables and their schemas in the current database.


scraperwiki.sql.table_info(name)

Returns an array of attributes for each element of the table.


scraperwiki.sql.save_var(key, value)

Saves an arbitrary single-value into a table called
<var>swvariables</var>. Intended to store scraper state so that
a scraper can continue after an interruption.


scraperwiki.sql.get_var(key[, default])

Retrieves a single value that was saved by <var>save_var</var>.
Only works for string, float, or int types.
For anything else, use the pickle
library
to turn it into a string.



Miscellaneous




scraperwiki.status(type, message=None)

If run on the ScraperWiki platform (the new one, not Classic), updates
the visible status of the dataset. If not on the platform, does nothing.
<var>params</var> can be 'ok' or
'error'. If no <var>message</var> is given, it will show the time since the update.
See dataset
status API
in the documentation for details.


scraperwiki.pdftoxml(pdfdata, options='')

Convert a byte string containing a PDF file into an XML file containing the coordinates
and font of each text string.
<var>options</var> is an optional string of options (!!) to be passed to the underlying pdftohtml command (see the pdftohtml documentation for details).

Refer to
the example
for more details.




 
File Type Py Version Uploaded on Size
scraperwiki-0.3.8.tar.gz (md5) Source 2014-01-29 6KB
  • Downloads (All Versions):
  • 143 downloads in the last day
  • 397 downloads in the last week
  • 1681 downloads in the last month