https://github.com/miniflux/python-client

Python client for Miniflux API
https://github.com/miniflux/python-client

api miniflux python

Last synced: 8 days ago
JSON representation

Python client for Miniflux API

• Host: GitHub
• URL: https://github.com/miniflux/python-client
• Owner: miniflux
• License: mit
• Created: 2017-12-25T00:14:48.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-09-04T04:19:12.000Z (2 months ago)
• Last Synced: 2024-10-04T06:48:20.653Z (about 1 month ago)
• Topics: api, miniflux, python
• Language: Python
• Homepage: https://pypi.org/project/miniflux/
• Size: 84 KB
• Stars: 52
• Watchers: 6
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
Miniflux Python API Client

==========================

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

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

Python client library for Miniflux API.

Requirements

------------

- Miniflux >= 2.0.49

- Python >= 3.7

- requests

Installation

------------

.. code:: bash

    python3 -m pip install miniflux

Running Tests

-------------

.. code:: bash

    python3 -m unittest -v

Usage Example

-------------

.. code:: python

    import miniflux

    # Creating a client using username / password authentication

    client = miniflux.Client("https://miniflux.example.org", username="my_username", password="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", category_id=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 entry title and content

    client.update_entry(entry_id=1234, title="New title", content="New content")

    # Update a feed category

    client.update_feed(123, category_id=456)

    # OPML Export

    opml = client.export_feeds()

    # OPML import

    client.import_feeds(opml_data)

    # Get application version

    client.get_version()

    # Flush history

    client.flush_history()

    # Get current user

    myself = client.me()

Look at `miniflux.py `_  to get the complete list of methods.

Author

------

Frédéric Guillot

License

-------

This library is distributed under MIT License.