Datasette plugin that adds a .atom output format
Project description
datasette-atom
Datasette plugin that adds support for generating Atom feeds with the results of a SQL query.
Installation
Install this plugin in the same environment as Datasette to enable the .atom
output extension.
$ pip install datasette-atom
Usage
To create an Atom feed you need to define a custom SQL query that returns a required set of columns:
atom_id
- a unique ID for each row. This article has suggestions about ways to create these IDs.atom_title
- a title for that row.atom_updated
- an RFC 3339 timestamp representing the last time the entry was modified in a significant way. This can usually be the time that the row was created.
The following columns are optional:
atom_content
- content that should be shown in the feed. This will be treated as a regular string, so any embedded HTML tags will be escaped when they are displayed.atom_content_html
- content that should be shown in the feed. This will be treated as an HTML string, and will be sanitized using Bleach to ensure it does not have any malicious code in it before being returned as part of a<content type="html">
Atom element. If both are provided, this will be used in place ofatom_content
.atom_link
- a URL that should be used as the link that the feed entry points to.
A query that returns these columns can then be returned as an Atom feed by adding the .atom
extension.
Example
Here is an example SQL query which generates an Atom feed for new entries on www.niche-museums.com:
select
'tag:niche-museums.com,' || substr(created, 0, 11) || ':' || id as atom_id,
name as atom_title,
created as atom_updated,
'https://www.niche-museums.com/browse/museums/' || id as atom_link,
coalesce(
'<img src="' || photo_url || '?w=800&h=400&fit=crop&auto=compress">',
''
) || '<p>' || description || '</p>' as atom_content_html
from
museums
order by
created desc
limit
15
You can try this query by pasting it in here - then click the .atom
link to see it as an Atom feed.
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 Distributions
Built Distribution
Hashes for datasette_atom-0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bb7a5a3900e2587377fac6ca8de97d3c9c74b0cba120bf3b6fb023b5e690771 |
|
MD5 | 1b0587760c42263e2047bc2c834e237c |
|
BLAKE2b-256 | f3772df2013cd988cb1521c60093d68187bbf94b8fb8d2166affa0fc65f7ad88 |