{"id":13595420,"url":"https://github.com/yazdipour/OmnivoreQL","last_synced_at":"2025-04-09T13:31:53.669Z","repository":{"id":177860695,"uuid":"659183474","full_name":"yazdipour/OmnivoreQL","owner":"yazdipour","description":"@Omnivore-app API client for Python","archived":false,"fork":false,"pushed_at":"2024-07-12T14:34:42.000Z","size":124,"stargazers_count":71,"open_issues_count":3,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-22T15:03:11.686Z","etag":null,"topics":["omnivore","omnivore-api","pip","python"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/omnivoreql/","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/yazdipour.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":["yazdipour"],"custom":["https://paypal.me/zhahriar"]}},"created_at":"2023-06-27T09:51:34.000Z","updated_at":"2025-02-02T09:54:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"342d55d8-9495-47c8-b25f-54e2bbfded6b","html_url":"https://github.com/yazdipour/OmnivoreQL","commit_stats":null,"previous_names":["yazdipour/omnivore-api-python"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yazdipour%2FOmnivoreQL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yazdipour%2FOmnivoreQL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yazdipour%2FOmnivoreQL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yazdipour%2FOmnivoreQL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yazdipour","download_url":"https://codeload.github.com/yazdipour/OmnivoreQL/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248049319,"owners_count":21039203,"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":["omnivore","omnivore-api","pip","python"],"created_at":"2024-08-01T16:01:49.669Z","updated_at":"2025-04-09T13:31:53.324Z","avatar_url":"https://github.com/yazdipour.png","language":"Python","funding_links":["https://github.com/sponsors/yazdipour","https://paypal.me/zhahriar"],"categories":["Python"],"sub_categories":[],"readme":"# OmnivoreQL: Omnivore API client for Python\n\n![OmnivoreQL Icon](https://github.com/yazdipour/OmnivoreQL/assets/8194807/d51d462d-4f5a-4031-980e-1faa5ca3f6e0)\n\nThis is a Python client for the [Omnivore API](https://omnivore.app).\n\n\n[![Tests](https://github.com/yazdipour/OmnivoreQL/actions/workflows/test.yml/badge.svg)](https://github.com/yazdipour/OmnivoreQL/actions/workflows/test.yml)\n[![PyPI version](https://badge.fury.io/py/omnivoreql.svg)](https://pypi.org/project/omnivoreql/)\n\n## How to use\n\nTo use omnivoreql in your Python project, you can follow these steps:\n\nInstall the omnivoreql package using pip:\n\n```bash\npip install omnivoreql\n```\n\nImport the package into your project and Create a new instance of the client:\n\n```python\nfrom omnivoreql import OmnivoreQL\n\nomnivoreql_client = OmnivoreQL(\"your_api_token_here\")\n```\n\nUse the methods of the OmnivoreQL class to interact with the Omnivore API. \n\n```python\nprofile = omnivoreql_client.get_profile()\n\nsaved_page = omnivoreql_client.save_url(\"https://www.google.com\")\nsaved_page_with_label = omnivoreql_client.save_url(\"https://www.google.com\", [\"label1\", \"label2\"])\n\narticles = omnivoreql_client.get_articles()\n\nusername = profile['me']['profile']['username']\nslug = articles['search']['edges'][0]['node']['slug']\narticles = omnivoreql_client.get_article(username, slug)\n\nsubscriptions = omnivoreql_client.get_subscriptions()\n\nlabels = omnivoreql_client.get_labels()\nfrom omnivoreql import CreateLabelInput\nomnivoreql_client.create_label(CreateLabelInput(\"label1\", \"#00ff00\", \"This is label description\"))\n```\n\n## Documentation\n\n* Main Omnivore graphql schema is in: [schema.graphql](https://github.com/omnivore-app/omnivore/blob/main/packages/api/src/schema.ts)\n* To contribute to this project: [CONTRIBUTING.md](docs/CONTRIBUTING.md)\n* To more know about Release process: [RELEASE.md](docs/RELEASE.md), [PYPI.md](docs/PYPI.md)\n\n## Support\n\nIf you find this project useful, you can support it by becoming a sponsor. Your contribution will help maintain the project and keep it up to date.\n\n[![GitHub stars](https://img.shields.io/github/stars/yazdipour/omnivoreql.svg?style=social\u0026label=Star)](https://github.com/yazdipour/omnivoreql/stargazers)\n[![Github Sponsor](https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026color=%23fe8e86)](https://github.com/sponsors/yazdipour)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Star History\n\nCheck out our growth in the community:\n\n[![Star History Chart](https://api.star-history.com/svg?repos=yazdipour/OmnivoreQL\u0026type=Date)](https://star-history.com/#yazdipour/OmnivoreQL\u0026Date)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyazdipour%2FOmnivoreQL","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyazdipour%2FOmnivoreQL","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyazdipour%2FOmnivoreQL/lists"}