omnivoreql

Name	omnivoreql JSON
Version	0.2.2 JSON
	download
home_page	https://github.com/yazdipour/OmnivoreQL
Summary	Omnivore API Client for Python
upload_time	2024-04-25 23:57:16
maintainer	None
docs_url	None
author	Shahriar Yazdipour
requires_python	>=3
license	MIT
keywords	omnivore api readlater graphql gql client
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # OmnivoreQL: Omnivore API client for Python

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

[![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)

[![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()

result = omnivoreql_client.save_url("https://www.google.com")

articles = omnivoreql_client.get_articles()

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

labels = omnivoreql_client.get_labels()
subscriptions = omnivoreql_client.get_subscriptions()
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/yazdipour/OmnivoreQL",
    "name": "omnivoreql",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": null,
    "keywords": "omnivore api readlater graphql gql client",
    "author": "Shahriar Yazdipour",
    "author_email": "git@yazdipour.com",
    "download_url": null,
    "platform": "any",
    "description": "# OmnivoreQL: Omnivore API client for Python\n\nThis is a Python client for the [Omnivore API](https://omnivore.app).\n\n[![GitHub stars](https://img.shields.io/github/stars/yazdipour/omnivoreql.svg?style=social&label=Star)](https://github.com/yazdipour/omnivoreql/stargazers)\n[![Github Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/yazdipour)\n\n[![Tests](https://github.com/yazdipour/OmnivoreQL/actions/workflows/test.yml/badge.svg)](https://github.com/yazdipour/OmnivoreQL/actions/workflows/test.yml)\n[![PyPI version](https://badge.fury.io/py/omnivoreql.svg)](https://pypi.org/project/omnivoreql/)\n\n## How to use\n\nTo use omnivoreql in your Python project, you can follow these steps:\n\nInstall the omnivoreql package using pip:\n\n```bash\npip install omnivoreql\n```\n\nImport the package into your project and Create a new instance of the client:\n\n```python\nfrom omnivoreql import OmnivoreQL\n\nomnivoreql_client = OmnivoreQL(\"your_api_token_here\")\n```\n\nUse the methods of the OmnivoreQL class to interact with the Omnivore API. \n\n```python\nprofile = omnivoreql_client.get_profile()\n\nresult = omnivoreql_client.save_url(\"https://www.google.com\")\n\narticles = omnivoreql_client.get_articles()\n\nusername = profile['me']['profile']['username']\nslug = articles['search']['edges'][0]['node']['slug']\narticles = omnivoreql_client.get_article(username, slug)\n\nlabels = omnivoreql_client.get_labels()\nsubscriptions = omnivoreql_client.get_subscriptions()\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Omnivore API Client for Python",
    "version": "0.2.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/yazdipour/OmnivoreQL/issues",
        "Homepage": "https://github.com/yazdipour/OmnivoreQL",
        "Source Code": "https://github.com/yazdipour/OmnivoreQL"
    },
    "split_keywords": [
        "omnivore",
        "api",
        "readlater",
        "graphql",
        "gql",
        "client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "671242ebc525f042e36dfbd1d498088d7d5e727eae2fdf6f43ba3d78e8d8c5b3",
                "md5": "52700a8d9a927e42a2478b9d7b9658ed",
                "sha256": "986fd9da9b725eea2f64781ae90b59f2f7cd4d6dfa63db6f7cfc5c0aedc3448f"
            },
            "downloads": -1,
            "filename": "omnivoreql-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "52700a8d9a927e42a2478b9d7b9658ed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 15355,
            "upload_time": "2024-04-25T23:57:16",
            "upload_time_iso_8601": "2024-04-25T23:57:16.109879Z",
            "url": "https://files.pythonhosted.org/packages/67/12/42ebc525f042e36dfbd1d498088d7d5e727eae2fdf6f43ba3d78e8d8c5b3/omnivoreql-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-25 23:57:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "yazdipour",
    "github_project": "OmnivoreQL",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "omnivoreql"
}