{"id":18293384,"url":"https://github.com/miniflux/python-client","last_synced_at":"2025-04-05T07:02:05.305Z","repository":{"id":27824507,"uuid":"115293593","full_name":"miniflux/python-client","owner":"miniflux","description":"Python client for Miniflux API","archived":false,"fork":false,"pushed_at":"2025-02-22T05:22:04.000Z","size":88,"stargazers_count":64,"open_issues_count":0,"forks_count":9,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-29T06:06:42.667Z","etag":null,"topics":["api","miniflux","python"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/miniflux/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/miniflux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-25T00:14:48.000Z","updated_at":"2025-03-18T20:42:25.000Z","dependencies_parsed_at":"2024-12-29T18:10:13.043Z","dependency_job_id":"8f4c3faf-b428-43de-8f1c-e50ee526bcb8","html_url":"https://github.com/miniflux/python-client","commit_stats":{"total_commits":41,"total_committers":4,"mean_commits":10.25,"dds":0.07317073170731703,"last_synced_commit":"7b21455ee57167de500f285beeae81bee29fa342"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miniflux%2Fpython-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miniflux%2Fpython-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miniflux%2Fpython-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miniflux%2Fpython-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/miniflux","download_url":"https://codeload.github.com/miniflux/python-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299829,"owners_count":20916190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","miniflux","python"],"created_at":"2024-11-05T14:24:06.691Z","updated_at":"2025-04-05T07:02:05.288Z","avatar_url":"https://github.com/miniflux.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"Miniflux Python API Client\n==========================\n\nPython client library for [Miniflux](https://miniflux.app).\n\nRequirements\n------------\n\n- Miniflux \u003e= 2.0.49\n- Python \u003e= 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édéric Guillot\n\nLicense\n-------\n\nThis library is distributed under MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminiflux%2Fpython-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminiflux%2Fpython-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminiflux%2Fpython-client/lists"}