All Projects → miniflux → python-client

miniflux / python-client

Licence: MIT License
Python client for Miniflux API

Programming Languages

python
139335 projects - #7 most used programming language

Projects that are alternatives of or similar to python-client

miniflux-sidekick
A sidekick for Miniflux, filter out items by regex or tags. Compatible with killfiles. 🔪
Stars: ✭ 34 (+17.24%)
Mutual labels:  miniflux
osmosfeed
Turn GitHub into an RSS reader
Stars: ✭ 839 (+2793.1%)
Mutual labels:  miniflux
arsse
The clean & modern RSS server that doesn't give you any crap. Mirror of main repository at https://code.mensbeam.com/MensBeam/arsse. Please direct your issues there.
Stars: ✭ 15 (-48.28%)
Mutual labels:  miniflux

Miniflux Python API Client

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

Author

Frédéric Guillot

License

This library is distributed under MIT License.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].