Skip to main content

Client library for Miniflux API

Project description

https://badge.fury.io/py/miniflux.svg

Python client library for Miniflux API.

Dependencies

  • Miniflux >= 2.x
  • Python >= 3.6
  • requests

Installation

pip install miniflux

Running Tests

pip install tox
tox

Usage Example

import miniflux

client = miniflux.Client("https://miniflux.example.org", "my_username", "my_secret_password")

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

# Update a feed category
client.update_feed(123, category_id=456)

# OPML Export
opml = client.export()

Author

Frédéric Guillot

License

This library is distributed under MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for miniflux, version 0.0.11
Filename, size File type Python version Upload date Hashes
Filename, size miniflux-0.0.11.tar.gz (4.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page