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:
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9b5bb0f19352c22b9f12b05c1d42eb7c0170f2a365d19de14cb32367e53d988d
|
|
| MD5 |
aae436d284a587fa0b61a90c14abe492
|
|
| BLAKE2b-256 |
f0ceca069bb14209a0e2dca73dd94c1a415d9512569b67182f447f366302a2dc
|
Provenance
The following attestation bundles were made for omnivore_api-0.4.0.tar.gz:
Publisher:
pypi.yml on Benature/OmnivoreAPI
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
omnivore_api-0.4.0.tar.gz -
Subject digest:
9b5bb0f19352c22b9f12b05c1d42eb7c0170f2a365d19de14cb32367e53d988d - Sigstore transparency entry: 186564351
- Sigstore integration time:
-
Permalink:
Benature/OmnivoreAPI@8937513653199a180b4e4867a7b53451b5a3473e -
Branch / Tag:
refs/tags/v0.4.0 - Owner: https://github.com/Benature
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@8937513653199a180b4e4867a7b53451b5a3473e -
Trigger Event:
push
-
Statement type:
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c949052a1dd87d87842e03ee362008a030ad9b08c99e6002eb2b14944c8a510f
|
|
| MD5 |
fbecb80b18f19ce58f51d28ffc8795c6
|
|
| BLAKE2b-256 |
72c17b340e9e4c8b87e0caac5e49d8cb5a478b89cf07355a33c44e9851e962ea
|
Provenance
The following attestation bundles were made for omnivore_api-0.4.0-py3-none-any.whl:
Publisher:
pypi.yml on Benature/OmnivoreAPI
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
omnivore_api-0.4.0-py3-none-any.whl -
Subject digest:
c949052a1dd87d87842e03ee362008a030ad9b08c99e6002eb2b14944c8a510f - Sigstore transparency entry: 186564352
- Sigstore integration time:
-
Permalink:
Benature/OmnivoreAPI@8937513653199a180b4e4867a7b53451b5a3473e -
Branch / Tag:
refs/tags/v0.4.0 - Owner: https://github.com/Benature
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@8937513653199a180b4e4867a7b53451b5a3473e -
Trigger Event:
push
-
Statement type:
