Skip to content

Commit fb11fdb

Browse files
committed
docs: update README.md to include available methods for miniflux.Client
1 parent feab4dd commit fb11fdb

2 files changed

Lines changed: 78 additions & 10 deletions

File tree

README.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,82 @@ with miniflux.Client("https://miniflux.domain.tld", api_key="secret") as clt:
9090
clt.me()
9191
```
9292

93-
Look at [miniflux.py](https://github.com/miniflux/python-client/blob/main/miniflux.py) for the complete list of methods.
93+
Available Methods
94+
-----------------
95+
96+
The following methods are available on the `miniflux.Client` object:
97+
98+
#### Application
99+
100+
- `get_version()`
101+
- `get_integrations_status()`
102+
103+
#### Subscriptions
104+
105+
- `export_feeds()`
106+
- `import_feeds(opml: str)`
107+
- `discover(website_url: str, **kwargs)`
108+
109+
#### Category Management
110+
111+
- `get_categories()`
112+
- `get_category_entry(category_id: int, entry_id: int)`
113+
- `get_category_entries(category_id: int, **kwargs)`
114+
- `create_category(title: str)`
115+
- `update_category(category_id: int, title: str)`
116+
- `delete_category(category_id: int)`
117+
118+
#### Feed Management
119+
120+
- `get_category_feeds(category_id: int)`
121+
- `get_feeds()`
122+
- `get_feed(feed_id: int)`
123+
- `get_feed_icon(feed_id: int)`
124+
- `get_icon(icon_id: int)`
125+
- `get_icon_by_feed_id(feed_id: int)`
126+
- `create_feed(feed_url: str, category_id: int|None = None, **kwargs)`
127+
- `update_feed(feed_id: int, **kwargs)`
128+
- `refresh_all_feeds()`
129+
- `refresh_feed(feed_id: int)`
130+
- `refresh_category(category_id: int)`
131+
- `delete_feed(feed_id: int)`
132+
- `get_feed_counters()`
133+
134+
#### Entry Management
135+
136+
- `flush_history()`
137+
- `get_feed_entry(feed_id: int, entry_id: int)`
138+
- `get_feed_entries(feed_id: int, **kwargs)`
139+
- `mark_feed_entries_as_read(feed_id: int)`
140+
- `get_entry(entry_id: int)`
141+
- `get_entries(**kwargs)`
142+
- `update_entry(entry_id: int, title: str|None = None, content: str|None = None)`
143+
- `update_entries(entry_ids: list[int], status: str)`
144+
- `fetch_entry_content(entry_id: int)`
145+
- `toggle_bookmark(entry_id: int)`
146+
- `save_entry(entry_id: int)`
147+
- `get_enclosure(enclosure_id: int)`
148+
- `update_enclosure(enclosure_id: int, media_progression: Optional[int] = None)`
149+
- `mark_category_entries_as_read(category_id: int)`
150+
- `mark_user_entries_as_read(user_id: int)`
151+
152+
#### User Management
153+
154+
- `me()`
155+
- `get_users()`
156+
- `get_user_by_id(user_id: int)`
157+
- `get_user_by_username(username: str)`
158+
- `create_user(username: str, password: str, is_admin: bool = False)`
159+
- `update_user(user_id: int, **kwargs)`
160+
- `delete_user(user_id: int)`
161+
162+
#### API Keys
163+
164+
- `get_api_keys()`
165+
- `create_api_key(description: str)`
166+
- `delete_api_key(api_key_id: int)`
167+
168+
Look at [miniflux.py](https://github.com/miniflux/python-client/blob/main/miniflux.py) for the complete list of methods and their detailed parameters.
94169

95170
Author
96171
------

pyproject.toml

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,14 @@ version = "1.1.4"
44
description = "Client library for Miniflux"
55
readme = "README.md"
66
requires-python = ">=3.8"
7-
license = {file = "LICENSE.txt"}
7+
license = "MIT"
8+
license-files = ["LICENSE.txt"]
89
keywords = ["rss", "atom", "rdf", "jsonfeed", "feed", "miniflux"]
910
authors = [
1011
{name = "Frédéric Guillot", email = "fred@miniflux.net"}
1112
]
1213
classifiers = [
1314
"Intended Audience :: Developers",
14-
"License :: OSI Approved :: MIT License",
15-
"Programming Language :: Python",
16-
"Programming Language :: Python :: 3.8",
17-
"Programming Language :: Python :: 3.9",
18-
"Programming Language :: Python :: 3.10",
19-
"Programming Language :: Python :: 3.11",
20-
"Programming Language :: Python :: 3.12",
21-
"Programming Language :: Python :: 3.13",
2215
"Programming Language :: Python :: 3 :: Only",
2316
]
2417
dependencies = [

0 commit comments

Comments
 (0)