Skip to content
Python client for Miniflux API
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests Make discover() method more flexible Oct 27, 2018
.gitignore First commit Dec 25, 2017
.travis.yml Change repo URL and change few things Jul 24, 2019
LICENSE.txt
MANIFEST.in
README.rst
miniflux.py Use Python f-strings Jul 24, 2019
setup.cfg First commit Dec 25, 2017
setup.py Update CI badge Jul 24, 2019
test-requirements.txt
tox.ini Change repo URL and change few things Jul 24, 2019

README.rst

Miniflux Python API Client

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

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.

You can’t perform that action at this time.