Client library for Miniflux
Project description
Python client library for Miniflux API.
Dependencies
Miniflux >= 2.0.49
Python >= 3.7
requests
Installation
python3 -m pip install miniflux
Running Tests
python3 -m unittest -v
Usage Example
import miniflux
# Creating a client using username / password authentication
client = miniflux.Client("https://miniflux.example.org", "my_username", "my_secret_password")
# Use an API Key (preferred method)
client = miniflux.Client("https://miniflux.example.org", api_key="My secret API token")
# Get all feeds
feeds = client.get_feeds()
# Refresh a feed
client.refresh_feed(123)
# Discover subscriptions from a website
subscriptions = client.discover("https://example.org")
# Create a new feed, with a personalized user agent and with the crawler enabled
feed_id = client.create_feed("http://example.org/feed.xml", 42, crawler=True, user_agent="GoogleBot")
# Fetch 10 starred entries
entries = client.get_entries(starred=True, limit=10)
# Fetch last 5 feed entries
feed_entries = client.get_feed_entries(123, direction='desc', order='published_at', limit=5)
# Fetch entries that belongs to a category with status unread and read
entries = client.get_entries(category_id=456, status=['read', 'unread'])
# Update a feed category
client.update_feed(123, category_id=456)
# OPML Export
opml = client.export_feeds()
# Get application version
client.get_version()
License
This library is distributed under MIT License.
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
miniflux-0.0.17.tar.gz
(7.4 kB
view hashes)
Built Distribution
Close
Hashes for miniflux-0.0.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c8f3db556af67ce15dd3beb632dd1f507e59a714c9dc12c1ac953acd68fb8d4 |
|
MD5 | aee6d34cbbe1110fa5ee1b6992e7b018 |
|
BLAKE2b-256 | 8963be6b9fc4b28acbac8fdbb7bd7aa0f2d6ec62e2ba87d67aa888ce8ef59eef |