https://github.com/yazdipour/OmnivoreQL

@Omnivore-app API client for Python
https://github.com/yazdipour/OmnivoreQL

omnivore omnivore-api pip python

Last synced: 14 days ago
JSON representation

@Omnivore-app API client for Python

• Host: GitHub
• URL: https://github.com/yazdipour/OmnivoreQL
• Owner: yazdipour
• License: mit
• Created: 2023-06-27T09:51:34.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-12T14:34:42.000Z (10 months ago)
• Last Synced: 2025-03-22T15:03:11.686Z (about 1 month ago)
• Topics: omnivore, omnivore-api, pip, python
• Language: Python
• Homepage: https://pypi.org/project/omnivoreql/
• Size: 121 KB
• Stars: 71
• Watchers: 4
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-github-stars - yazdipour/OmnivoreQL - @Omnivore-app API client for Python (Python)

README

        
# OmnivoreQL: Omnivore API client for Python

![OmnivoreQL Icon](https://github.com/yazdipour/OmnivoreQL/assets/8194807/d51d462d-4f5a-4031-980e-1faa5ca3f6e0)

This is a Python client for the [Omnivore API](https://omnivore.app).

[![Tests](https://github.com/yazdipour/OmnivoreQL/actions/workflows/test.yml/badge.svg)](https://github.com/yazdipour/OmnivoreQL/actions/workflows/test.yml)

[![PyPI version](https://badge.fury.io/py/omnivoreql.svg)](https://pypi.org/project/omnivoreql/)

## How to use

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

Install the omnivoreql package using pip:

```bash

pip install omnivoreql

```

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

```python

from omnivoreql import OmnivoreQL

omnivoreql_client = OmnivoreQL("your_api_token_here")

```

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

```python

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](https://github.com/omnivore-app/omnivore/blob/main/packages/api/src/schema.ts)

* To contribute to this project: [CONTRIBUTING.md](docs/CONTRIBUTING.md)

* To more know about Release process: [RELEASE.md](docs/RELEASE.md), [PYPI.md](docs/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.

[![GitHub stars](https://img.shields.io/github/stars/yazdipour/omnivoreql.svg?style=social&label=Star)](https://github.com/yazdipour/omnivoreql/stargazers)

[![Github Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/yazdipour)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Star History

Check out our growth in the community:

[![Star History Chart](https://api.star-history.com/svg?repos=yazdipour/OmnivoreQL&type=Date)](https://star-history.com/#yazdipour/OmnivoreQL&Date)