| Name | miniflux JSON |
| Version |
1.1.3
JSON |
| download |
| home_page | None |
| Summary | Client library for Miniflux |
| upload_time | 2025-01-26 21:13:10 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | The MIT License (MIT)
Copyright (c) Frédéric Guillot
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
|
| keywords |
rss
atom
rdf
jsonfeed
feed
miniflux
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Miniflux Python API Client
==========================
Python client library for [Miniflux](https://miniflux.app).
Requirements
------------
- Miniflux >= 2.0.49
- Python >= 3.8
- requests
This project uses [Ruff](https://docs.astral.sh/ruff/) for linting and formatting.
Installation
------------
```bash
python3 -m pip install miniflux
```
Running Tests
-------------
```bash
python3 -m unittest -v
```
Examples
--------
```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()
```
You can also use a context manager:
```python
import miniflux
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.
Author
------
Frédéric Guillot
License
-------
This library is distributed under MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "miniflux",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "rss, atom, rdf, jsonfeed, feed, miniflux",
"author": null,
"author_email": "Fr\u00e9d\u00e9ric Guillot <fred@miniflux.net>",
"download_url": "https://files.pythonhosted.org/packages/6e/89/6834b30a8310279a45e3ccc870644c80b9fa9af2b344814f84f514210015/miniflux-1.1.3.tar.gz",
"platform": null,
"description": "Miniflux Python API Client\n==========================\n\nPython client library for [Miniflux](https://miniflux.app).\n\nRequirements\n------------\n\n- Miniflux >= 2.0.49\n- Python >= 3.8\n- requests\n\nThis project uses [Ruff](https://docs.astral.sh/ruff/) for linting and formatting.\n\nInstallation\n------------\n\n```bash\npython3 -m pip install miniflux\n```\n\nRunning Tests\n-------------\n\n```bash\npython3 -m unittest -v\n```\n\nExamples\n--------\n\n```python\nimport miniflux\n\n# Creating a client using username / password authentication\nclient = miniflux.Client(\"https://miniflux.example.org\", username=\"my_username\", password=\"my_secret_password\")\n\n# Use an API Key (preferred method)\nclient = miniflux.Client(\"https://miniflux.example.org\", api_key=\"My secret API token\")\n\n# Get all feeds\nfeeds = client.get_feeds()\n\n# Refresh a feed\nclient.refresh_feed(123)\n\n# Discover subscriptions from a website\nsubscriptions = client.discover(\"https://example.org\")\n\n# Create a new feed, with a personalized user agent and with the crawler enabled\nfeed_id = client.create_feed(\"http://example.org/feed.xml\", category_id=42, crawler=True, user_agent=\"GoogleBot\")\n\n# Fetch 10 starred entries\nentries = client.get_entries(starred=True, limit=10)\n\n# Fetch last 5 feed entries\nfeed_entries = client.get_feed_entries(123, direction='desc', order='published_at', limit=5)\n\n# Fetch entries that belongs to a category with status unread and read\nentries = client.get_entries(category_id=456, status=['read', 'unread'])\n\n# Update entry title and content\nclient.update_entry(entry_id=1234, title=\"New title\", content=\"New content\")\n\n# Update a feed category\nclient.update_feed(123, category_id=456)\n\n# OPML Export\nopml = client.export_feeds()\n\n# OPML import\nclient.import_feeds(opml_data)\n\n# Get application version\nclient.get_version()\n\n# Flush history\nclient.flush_history()\n\n# Get current user\nmyself = client.me()\n```\n\nYou can also use a context manager:\n\n```python\nimport miniflux\n\nwith miniflux.Client(\"https://miniflux.domain.tld\", api_key=\"secret\") as clt:\n clt.me()\n```\n\nLook at [miniflux.py](https://github.com/miniflux/python-client/blob/main/miniflux.py) for the complete list of methods.\n\nAuthor\n------\n\nFr\u00e9d\u00e9ric Guillot\n\nLicense\n-------\n\nThis library is distributed under MIT License.\n",
"bugtrack_url": null,
"license": "The MIT License (MIT)\n \n Copyright (c) Fr\u00e9d\u00e9ric Guillot\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in\n all copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n THE SOFTWARE.\n ",
"summary": "Client library for Miniflux",
"version": "1.1.3",
"project_urls": {
"Bug Reports": "https://github.com/miniflux/python-client/issues",
"Homepage": "https://github.com/miniflux/python-client",
"Source": "https://github.com/miniflux/python-client"
},
"split_keywords": [
"rss",
" atom",
" rdf",
" jsonfeed",
" feed",
" miniflux"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6b91e3c2a0a36263f6d0bf26cd893f1efcd78f20443cd85a269d9b65078aaff6",
"md5": "6b01a1087a73ab4fca18cbb00b6403db",
"sha256": "bb3f72a44ce76cde6b0acec79973ab067364048263fb82349fc9b0a69943d6db"
},
"downloads": -1,
"filename": "miniflux-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b01a1087a73ab4fca18cbb00b6403db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7918,
"upload_time": "2025-01-26T21:13:09",
"upload_time_iso_8601": "2025-01-26T21:13:09.033680Z",
"url": "https://files.pythonhosted.org/packages/6b/91/e3c2a0a36263f6d0bf26cd893f1efcd78f20443cd85a269d9b65078aaff6/miniflux-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6e896834b30a8310279a45e3ccc870644c80b9fa9af2b344814f84f514210015",
"md5": "926e35cbe5f9987d5bacc66b6798d046",
"sha256": "ac46dd24f50b1fe3dfaf50f5d18ecdd77dc6128bc75fea805866bbe975015324"
},
"downloads": -1,
"filename": "miniflux-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "926e35cbe5f9987d5bacc66b6798d046",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10448,
"upload_time": "2025-01-26T21:13:10",
"upload_time_iso_8601": "2025-01-26T21:13:10.248789Z",
"url": "https://files.pythonhosted.org/packages/6e/89/6834b30a8310279a45e3ccc870644c80b9fa9af2b344814f84f514210015/miniflux-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-26 21:13:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "miniflux",
"github_project": "python-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "miniflux"
}
