Skip to main content

Webmention Manager

Project description

Downloads Circle CI CodeCov Requirements Status

論及 ronkyuu - mention, reference to, touching upon

Python package to help with parsing, handling and other manipulations of the IndieWeb Toolkit items, such as:

  • 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
  • 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 for it's amazing HTML wrangling ability, you have the option of enabling faster parsing via the lxml package instead of the default html5lib package. This is done by having lxml installed and...

import ronkyuu

ronkyuu.webmention.setParser('lxml')

Contributors

  • bear (Mike Taylor)
  • kartikprabhu (Kartik Prabhu)

WebMentions

findMentions()

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()

Search the given html content for all elements and return any discovered WebMention URL.

discoverEndpoint()

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()

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()

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 v3.7+ but see Pipfile for a full list. The Makefile takes advantage of Pipenv (which will use pyenv if installed) to manage the Python dependencies.

For testing we use httmock to mock the web calls.

Project details


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.7.tar.gz (74.8 kB view details)

Uploaded Source

Built Distribution

ronkyuu-0.7-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file ronkyuu-0.7.tar.gz.

File metadata

  • Download URL: ronkyuu-0.7.tar.gz
  • Upload date:
  • Size: 74.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.4

File hashes

Hashes for ronkyuu-0.7.tar.gz
Algorithm Hash digest
SHA256 fa34362858c91761098697225eb3bf848ad09c63f8114ae9eb57f040d515b125
MD5 8cc689d5aba5b7f05267196e169f7fdc
BLAKE2b-256 c6db65ad528b6ebe9176eff19417ceb68801e6b1b4a14fef3f8cdee1e6dd2b7c

See more details on using hashes here.

File details

Details for the file ronkyuu-0.7-py3-none-any.whl.

File metadata

  • Download URL: ronkyuu-0.7-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.4

File hashes

Hashes for ronkyuu-0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 846707b1608595f5ddec8395bc0eb2dca33dc7c0ae8103ece2d2673aa855459a
MD5 4da7f44afaada934a96839c1afb56706
BLAKE2b-256 29c839f585c6b3a648fdf80f50e135a92b2b75e2fa4c269f224f496d836532c0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page