Skip to content

Remove the HTTP API #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 15, 2020
Merged

Remove the HTTP API #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 0 additions & 100 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ extruct

*extruct* is a library for extracting embedded metadata from HTML markup.

It also has a built-in HTTP server to test its output as JSON.

Currently, *extruct* supports:

- `W3C's HTML Microdata`_
Expand Down Expand Up @@ -586,104 +584,6 @@ Microformat extraction
}
}]

REST API service
----------------

*extruct* also ships with a REST API service to test its output from URLs.

Dependencies
++++++++++++

* bottle_ (Web framework)
* gevent_ (Aysnc framework)
* requests_

.. _bottle: https://pypi.python.org/pypi/bottle
.. _gevent: http://www.gevent.org/
.. _requests: http://docs.python-requests.org/

Usage
+++++

::

python -m extruct.service

launches an HTTP server listening on port 10005.

Methods supported
+++++++++++++++++

::

/extruct/<URL>
method = GET


/extruct/batch
method = POST
params:
urls - a list of URLs separted by newlines
urlsfile - a file with one URL per line

E.g. http://localhost:10005/extruct/http://www.sarenza.com/i-love-shoes-susket-s767163-p0000119412

will output something like this:

>>>
{ 'json-ld': [ { '@context': 'http://schema.org',
'@id': 'FP',
'@type': 'Product',
'brand': { '@type': 'Brand',
'url': 'https://www.sarenza.com/i-love-shoes'},
'color': ['Lava', 'Black', 'Lt grey'],
'image': [ 'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_09.jpg?201509221045&v=20180313113923',
'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_02.jpg?201509291747&v=20180313113923',
'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_03.jpg?201509221045&v=20180313113923',
'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_04.jpg?201509221045&v=20180313113923',
'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_05.jpg?201509221045&v=20180313113923',
'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_06.jpg?201509221045&v=20180313113923',
'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_07.jpg?201509221045&v=20180313113923',
'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_08.jpg?201509221045&v=20180313113923'],
'name': 'Susket',
'offers': { '@type': 'AggregateOffer',
'availability': 'InStock',
'highPrice': '49.00',
'lowPrice': '0.00',
'price': '0.00',
'priceCurrency': 'EUR'}}],
'microdata': [ { 'properties': { 'average': '4.7',
'best': '5',
'itemreviewed': 'Sarenza',
'rating': '4.7 / 5\n\t\t (4 066 avis)',
'votes': '4 066'},
'type': 'http://data-vocabulary.org/Review-aggregate'}],
'microformat': [],
'opengraph': [ { 'namespace': {'og': 'http://ogp.me/ns#'},
'properties': [ ( 'og:title',
'I Love Shoes Susket @sarenza.com'),
( 'og:image',
'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_09.jpg?201509221045&v=20180313113923'),
('og:site_name', 'sarenza.com'),
('og:type', 'product'),
('og:description', '...'),
( 'og:url',
'https://www.sarenza.com/i-love-shoes-susket-s767163-p0000119412'),
('og:country-name', 'FRA')]}],
'rdfa': [ { '@id': 'https://www.sarenza.com/i-love-shoes-susket-s767163-p0000119412',
'http://ogp.me/ns#country-name': [{'@value': 'FRA'}],
'http://ogp.me/ns#description': [{'@value': '...'}],
'http://ogp.me/ns#image': [ { '@value': 'https://cdn.sarenza.net/_img/productsv4/0000119412/MD_0000119412_223992_09.jpg?201509221045&v=20180313113923'}],
'http://ogp.me/ns#site_name': [{'@value': 'sarenza.com'}],
'http://ogp.me/ns#title': [ { '@value': 'I Love Shoes Susket '
'@sarenza.com'}],
'http://ogp.me/ns#type': [{'@value': 'product'}],
'http://ogp.me/ns#url': [ { '@value': 'https://www.sarenza.com/i-love-shoes-susket-s767163-p0000119412'}],
'http://ogp.me/ns/fb#admins': [{'@value': '100001934697625'}],
'http://ogp.me/ns/fb#app_id': [{'@value': '148128758532914'}]},
{ '@id': '_:Ncf1962068aa142b29000813372db7841',
'http://www.w3.org/1999/xhtml/vocab#role': [ { '@id': 'http://www.w3.org/1999/xhtml/vocab#navigation'}]}]}


Command Line Tool
-----------------
Expand Down
86 changes: 0 additions & 86 deletions extruct/service.py
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# project requirements, install them using following command:
# pip install -r requirements.txt
lxml
bottle
gevent
requests
rdflib
rdflib-jsonld
Expand Down
5 changes: 0 additions & 5 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,6 @@ def get_version():
'html-text>=0.5.1',
'six'],
extras_require={
'service': [
'bottle',
'gevent',
'requests',
],
'cli': [
'requests',
],
Expand Down