diff --git a/README.md b/README.md index f387bea..0a9fe84 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,82 @@ with miniflux.Client("https://miniflux.domain.tld", api_key="secret") as clt: clt.me() ``` -Look at [miniflux.py](https://github.com/miniflux/python-client/blob/main/miniflux.py) for the complete list of methods. +Available Methods +----------------- + +The following methods are available on the `miniflux.Client` object: + +#### Application + +- `get_version()` +- `get_integrations_status()` + +#### Subscriptions + +- `export_feeds()` +- `import_feeds(opml: str)` +- `discover(website_url: str, **kwargs)` + +#### Category Management + +- `get_categories()` +- `get_category_entry(category_id: int, entry_id: int)` +- `get_category_entries(category_id: int, **kwargs)` +- `create_category(title: str)` +- `update_category(category_id: int, title: str)` +- `delete_category(category_id: int)` + +#### Feed Management + +- `get_category_feeds(category_id: int)` +- `get_feeds()` +- `get_feed(feed_id: int)` +- `get_feed_icon(feed_id: int)` +- `get_icon(icon_id: int)` +- `get_icon_by_feed_id(feed_id: int)` +- `create_feed(feed_url: str, category_id: int|None = None, **kwargs)` +- `update_feed(feed_id: int, **kwargs)` +- `refresh_all_feeds()` +- `refresh_feed(feed_id: int)` +- `refresh_category(category_id: int)` +- `delete_feed(feed_id: int)` +- `get_feed_counters()` + +#### Entry Management + +- `flush_history()` +- `get_feed_entry(feed_id: int, entry_id: int)` +- `get_feed_entries(feed_id: int, **kwargs)` +- `mark_feed_entries_as_read(feed_id: int)` +- `get_entry(entry_id: int)` +- `get_entries(**kwargs)` +- `update_entry(entry_id: int, title: str|None = None, content: str|None = None)` +- `update_entries(entry_ids: list[int], status: str)` +- `fetch_entry_content(entry_id: int)` +- `toggle_bookmark(entry_id: int)` +- `save_entry(entry_id: int)` +- `get_enclosure(enclosure_id: int)` +- `update_enclosure(enclosure_id: int, media_progression: Optional[int] = None)` +- `mark_category_entries_as_read(category_id: int)` +- `mark_user_entries_as_read(user_id: int)` + +#### User Management + +- `me()` +- `get_users()` +- `get_user_by_id(user_id: int)` +- `get_user_by_username(username: str)` +- `create_user(username: str, password: str, is_admin: bool = False)` +- `update_user(user_id: int, **kwargs)` +- `delete_user(user_id: int)` + +#### API Keys + +- `get_api_keys()` +- `create_api_key(description: str)` +- `delete_api_key(api_key_id: int)` + +Look at [miniflux.py](https://github.com/miniflux/python-client/blob/main/miniflux.py) for the complete list of methods and their detailed parameters. Author ------ diff --git a/pyproject.toml b/pyproject.toml index bbcc17b..037fa9d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,14 +11,6 @@ authors = [ ] classifiers = [ "Intended Audience :: Developers", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: 3.12", - "Programming Language :: Python :: 3.13", "Programming Language :: Python :: 3 :: Only", ] dependencies = [