Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
A simple way to access the Webz.io <https://webz.io/>
_ API from your Python code::
.. code-block:: python
import webzio
webzio.config(token=YOUR_API_KEY)
output = webzio.query("filterWebContent", {"q":"github"})
print output['posts'][0]['text'] # Print the text of the first post
print output['posts'][0]['published'] # Print the text of the first post publication date
# Get the next batch of posts
output = webzio.get_next()
print output['posts'][0]['thread']['site'] # Print the site of the first post
To make use of the webz.io API, you need to obtain a token that would be used on every request. To obtain an API key, create an account at https://webz.io/auth/signup, and then go into https://webz.io/dashboard to see your token.
You can install from source:
.. code-block:: bash
$ git clone https://github.com/webz.io/webzio-python
$ cd webzio-python
$ python setup.py install
Or use pip install:
.. code-block:: bash
$ sudo pip install webzio
To get started, you need to import the library, and set your access token. (Replace YOUR_API_KEY with your actual API key).
.. code-block:: python
>>> import webzio
>>> webzio.config(token=YOUR_API_KEY)
API Endpoints
The first parameter the query() function accepts is the API endpoint string. Available endpoints:
Now you can make a request and inspect the results:
.. code-block:: python
>>> output = webzio.query("filterWebContent", {"q":"github"})
>>> output['totalResults']
15565094
len(output['posts'])
100
>>> output['posts'][0]['language']
u'english'
>>> output['posts'][0]['title']
u'Putting quotes around dictionary keys in JS'
For your convenience, the ouput object is iterable, so you can loop over it and get all the results of this batch (up to 100).
.. code-block:: python
>>> total_words = 0
>>> for post in output['posts']:
... total_words += len(post['text'].split(" "))
...
>>> print(total_words)
8822
config(token)
query(end_point_str, params)
end_point_str:
params: A key value dictionary. The most common key is the "q" parameter that hold the filters Boolean query. Read about the available filters.
get_next()
- a method to fetch the next page of results.
If you want to make repeated searches, performing an action whenever there are new results, use code like this:
.. code-block:: python
r = webzio.query("filterWebContent", {"q":"skyrim"})
while True:
for post in r['posts']:
perform_action(post)
time.sleep(300)
r = webzio.get_next()
FAQs
Simple client library for the webz.io REST API
We found that webzio demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.