Skip to main content

Omnivore API Client for Python

Project description

OmnivoreAPI: Omnivore API client for Python

Forked from OmnivoreAPI

OmnivoreAPI Icon

This is a Python client for the Omnivore API.

Tests PyPI version

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

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.

GitHub stars Github Sponsor

License

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

Star History

Check out our growth in the community:

Star History Chart

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omnivore_api-0.4.0.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

omnivore_api-0.4.0-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file omnivore_api-0.4.0.tar.gz.

File metadata

  • Download URL: omnivore_api-0.4.0.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for omnivore_api-0.4.0.tar.gz
Algorithm Hash digest
SHA256 9b5bb0f19352c22b9f12b05c1d42eb7c0170f2a365d19de14cb32367e53d988d
MD5 aae436d284a587fa0b61a90c14abe492
BLAKE2b-256 f0ceca069bb14209a0e2dca73dd94c1a415d9512569b67182f447f366302a2dc

See more details on using hashes here.

Provenance

The following attestation bundles were made for omnivore_api-0.4.0.tar.gz:

Publisher: pypi.yml on Benature/OmnivoreAPI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file omnivore_api-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: omnivore_api-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for omnivore_api-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c949052a1dd87d87842e03ee362008a030ad9b08c99e6002eb2b14944c8a510f
MD5 fbecb80b18f19ce58f51d28ffc8795c6
BLAKE2b-256 72c17b340e9e4c8b87e0caac5e49d8cb5a478b89cf07355a33c44e9851e962ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for omnivore_api-0.4.0-py3-none-any.whl:

Publisher: pypi.yml on Benature/OmnivoreAPI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page