Python client for Miniflux API
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tests
.gitignore
.travis.yml
LICENSE.txt
MANIFEST.in
README.rst
miniflux.py
setup.cfg
setup.py
test-requirements.txt
tox.ini

README.rst

Miniflux Python API Client

https://travis-ci.org/miniflux/miniflux-python.svg?branch=master Documentation Status

Client library for Miniflux REST API.

Dependencies

  • Miniflux >= 2.x
  • Python >= 3.4
  • 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)

Author

Frédéric Guillot

License

This library is distributed under MIT License.