Client library for Miniflux API
Project description
Python client library for Miniflux API.
Dependencies
Miniflux >= 2.x
Python >= 3.6
requests
Installation
pip install miniflux
Running Tests
python setup.py test
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.16.tar.gz
(6.8 kB
view hashes)
Built Distribution
Close
Hashes for miniflux-0.0.16-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb7015abfed618ab942a69c59370137bc5625c3786612d7dada6cd42bdb71c70 |
|
MD5 | c46f94c9e4d086a2c1cdf4d3c95061be |
|
BLAKE2b-256 | a2828f29ef9b0929ccccc2db93569c8cae171b81edf2aa40f35ca4624149c331 |