OmnivoreQL: Omnivore API client for Python

This is a Python client for the Omnivore API.

How to use

To use omnivoreql in your Python project, you can follow these steps:

Install the omnivoreql package using pip:

pip install omnivoreql

Import the package into your project and Create a new instance of the client:

from omnivoreql import OmnivoreQL

omnivoreql_client = OmnivoreQL("your_api_token_here")

Use the methods of the OmnivoreQL class to interact with the Omnivore API.

profile = omnivoreql_client.get_profile()

saved_page = omnivoreql_client.save_url("https://www.google.com")
saved_page_with_label = omnivoreql_client.save_url("https://www.google.com", ["label1", "label2"])

articles = omnivoreql_client.get_articles()

username = profile['me']['profile']['username']
slug = articles['search']['edges'][0]['node']['slug']
articles = omnivoreql_client.get_article(username, slug)

subscriptions = omnivoreql_client.get_subscriptions()

labels = omnivoreql_client.get_labels()
from omnivoreql import CreateLabelInput
omnivoreql_client.create_label(CreateLabelInput("label1", "#00ff00", "This is label description"))

Documentation

• Main Omnivore graphql schema is in: schema.graphql
• To contribute to this project: CONTRIBUTING.md
• To more know about Release process: RELEASE.md, PYPI.md

Support

If 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.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Star History

Check out our growth in the community: