Webmention Manager
Project description
ronkyuu
=======
論及 ronkyuu - mention, reference to, touching upon
Python package to help with parsing, handling and other manipulations
of the IndieWeb Toolkit items, such as:
* [Webmention](http://indiewebcamp.com/webmention)
* Discovery of mentions in a publisher's post, the handling of finding what the Webmention callback is for the reference and also handling of incoming Webmention requests are handled.
* [RelMe](http://microformats.org/wiki/rel-me)
* Take a source URL and a resource URL that is supposed to be a rel=me for the source and verify that it is.
Roadmap
=======
Working
* Mention discovery in a post
* Discovery of Webmention callback for a link
* POST of Webmention to discovered callback
* Receipt of a Webmention POST
* support for RelMe verification
Pending
* IndieAuth tools
* MicroPub support
See the examples/ directory for sample command line tools.
Contributors
============
* bear (Mike Taylor)
* kartikprabhu (Kartik Prabhu)
WebMentions
===========
findMentions(sourceURL, domains=[])
-----------------------------------
Find all <a /> elements in the html returned for a post.
If any have an href attribute that is not from the one of the items in domains, append it to our lists.
findEndpoint(html)
------------------
Search the given html content for all <link /> elements and return any discovered WebMention URL.
discoverEndpoint(url)
---------------------
Discover any WebMention endpoint for a given URL.
sendWebmention(sourceURL, targetURL, webmention=None)
-----------------------------------------------------
Send to the targetURL a WebMention for the sourceURL.
The WebMention will be discovered if not given in the optional webmention parameter.
RelMe
=====
findRelMe(sourceURL)
--------------------
Find all <a /> elements in the given html for a post.
If any have an href attribute that is rel="me" then include it in the result.
confirmRelMe(profileURL, resourceURL, profileRelMes=None, resourceRelMes=None)
------------------------------------------------------------------------------
Determine if a given resourceURL is authoritative for the profileURL.
The list of rel="me" links will be discovered if not provided in the optional
profileRelMes parameter or the resourceRelMes paramter.
Validators
==========
URLValidator class
TODO: fill in details of how to use
Requires
========
Python v2.6+ but see requirements.txt for a full list
Installing the latest version of Requests and it's OAuth plugin now requires pyOpenSSL which
will require compiling of source libs. You may need to have installed the -dev package for the
version of Python you are working with.
For testing I use [httmock](https://pypi.python.org/pypi/httmock/) to stub the web calls
=======
論及 ronkyuu - mention, reference to, touching upon
Python package to help with parsing, handling and other manipulations
of the IndieWeb Toolkit items, such as:
* [Webmention](http://indiewebcamp.com/webmention)
* Discovery of mentions in a publisher's post, the handling of finding what the Webmention callback is for the reference and also handling of incoming Webmention requests are handled.
* [RelMe](http://microformats.org/wiki/rel-me)
* Take a source URL and a resource URL that is supposed to be a rel=me for the source and verify that it is.
Roadmap
=======
Working
* Mention discovery in a post
* Discovery of Webmention callback for a link
* POST of Webmention to discovered callback
* Receipt of a Webmention POST
* support for RelMe verification
Pending
* IndieAuth tools
* MicroPub support
See the examples/ directory for sample command line tools.
Contributors
============
* bear (Mike Taylor)
* kartikprabhu (Kartik Prabhu)
WebMentions
===========
findMentions(sourceURL, domains=[])
-----------------------------------
Find all <a /> elements in the html returned for a post.
If any have an href attribute that is not from the one of the items in domains, append it to our lists.
findEndpoint(html)
------------------
Search the given html content for all <link /> elements and return any discovered WebMention URL.
discoverEndpoint(url)
---------------------
Discover any WebMention endpoint for a given URL.
sendWebmention(sourceURL, targetURL, webmention=None)
-----------------------------------------------------
Send to the targetURL a WebMention for the sourceURL.
The WebMention will be discovered if not given in the optional webmention parameter.
RelMe
=====
findRelMe(sourceURL)
--------------------
Find all <a /> elements in the given html for a post.
If any have an href attribute that is rel="me" then include it in the result.
confirmRelMe(profileURL, resourceURL, profileRelMes=None, resourceRelMes=None)
------------------------------------------------------------------------------
Determine if a given resourceURL is authoritative for the profileURL.
The list of rel="me" links will be discovered if not provided in the optional
profileRelMes parameter or the resourceRelMes paramter.
Validators
==========
URLValidator class
TODO: fill in details of how to use
Requires
========
Python v2.6+ but see requirements.txt for a full list
Installing the latest version of Requests and it's OAuth plugin now requires pyOpenSSL which
will require compiling of source libs. You may need to have installed the -dev package for the
version of Python you are working with.
For testing I use [httmock](https://pypi.python.org/pypi/httmock/) to stub the web calls
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ronkyuu-0.2.7.tar.gz
(10.6 kB
view hashes)