OmnivoreAPI: Omnivore API client for Python

Forked from OmnivoreAPI

This is a Python client for the Omnivore API.

How to use

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

Install the omnivore_api package using pip:

pip install omnivore_api

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

from omnivore_api import OmnivoreAPI

omnivore = OmnivoreAPI("your_api_token_here", "your_api_url_here")

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

profile = omnivore.get_profile()

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

articles = omnivore.get_articles()

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

subscriptions = omnivore.get_subscriptions()

labels = omnivore.get_labels()
from omnivore_api import CreateLabelInput
omnivore.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: