Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bear/ronkyuu
論及 ronkyuu - mention, reference to, touching upon
https://github.com/bear/ronkyuu
Last synced: 27 days ago
JSON representation
論及 ronkyuu - mention, reference to, touching upon
- Host: GitHub
- URL: https://github.com/bear/ronkyuu
- Owner: bear
- License: mit
- Created: 2013-11-27T01:33:06.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2024-08-07T23:32:10.000Z (4 months ago)
- Last Synced: 2024-11-12T10:04:57.300Z (30 days ago)
- Language: HTML
- Size: 353 KB
- Stars: 42
- Watchers: 7
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - bear/ronkyuu - 論及 ronkyuu - mention, reference to, touching upon (others)
README
[](https://pypi.python.org/pypi/ronkyuu/)
[](https://circleci.com/gh/bear/ronkyuu)
[](http://codecov.io/github/bear/ronkyuu)
[](https://requires.io/github/bear/ronkyuu/requirements/?branch=master)
論及 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.
See the examples/ directory for sample command line tools.
Because Ronkyuu uses [BeautifulSoup4](https://pypi.org/project/beautifulsoup4/) for it's amazing HTML wrangling ability, you have the option of enabling faster parsing via the [`lxml`](https://pypi.org/project/lxml/) package instead of the default [`html5lib`](https://pypi.org/project/html5lib/) package.
```
import ronkyuu
ronkyuu.webmention.setParser('lxml')
```
Contributors
============
* bear (Mike Taylor)
* kartikprabhu (Kartik Prabhu)
WebMentions
===========
findMentions(sourceURL, targetURL, ...)
---------------------------------------
Find all `` 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 `` elements and return any discovered WebMention URL.
discoverEndpoint(sourceURL, ...)
--------------------------------
Discover any WebMention endpoint for a given `sourceURL`.
sendWebmention(sourceURL, targetURL, webmention)
------------------------------------------------
Send to the `targetURL` a WebMention for the `sourceURL`.
The WebMention will be discovered if it is not given in the optional `webmention` parameter.
RelMe
=====
findRelMe(sourceURL)
--------------------
Find all `` 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, resourceRelMes)
--------------------------------------------------------------------
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` parameter.
Validators
==========
URLValidator class
TODO: fill in details of how to use
Requires
========
Python v3.9+ -- see `Pipfile` for the full list
The `Makefile` takes advantage of `Pipenv` (which will use `pyenv` if installed) to manage the Python dependencies.
For testing we use [httmock](https://pypi.python.org/pypi/httmock/) to mock the web calls.