ringba-api-client


Nameringba-api-client JSON
Version 0.0.1 PyPI version JSON
download
home_pagehttps://github.com/nat5142/ringba-api-client
SummarySimple Rrequest package to integrate with the Ringba Public API
upload_time2024-02-09 21:59:25
maintainer
docs_urlNone
authorNick Tulli
requires_python>=3.8,<3.12
license
keywords ringba-api-client
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
# Ringba API Client


<div align="center">

[![PyPI - Version](https://img.shields.io/pypi/v/ringba-api-client.svg)](https://pypi.python.org/pypi/ringba-api-client)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ringba-api-client.svg)](https://pypi.python.org/pypi/ringba-api-client)
[![Tests](https://github.com/nat5142/ringba-api-client/workflows/tests/badge.svg)](https://github.com/nat5142/ringba-api-client/actions?workflow=tests)
[![Codecov](https://codecov.io/gh/nat5142/ringba-api-client/branch/main/graph/badge.svg)](https://codecov.io/gh/nat5142/ringba-api-client)
[![Read the Docs](https://readthedocs.org/projects/ringba-api-client/badge/)](https://ringba-api-client.readthedocs.io/)
[![PyPI - License](https://img.shields.io/pypi/l/ringba-api-client.svg)](https://pypi.python.org/pypi/ringba-api-client)

[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)


</div>


Simple Rrequest package to integrate with the Ringba Public API


* GitHub repo: <https://github.com/nat5142/ringba-api-client.git>
* Documentation: <https://ringba-api-client.readthedocs.io>
* Free software: MIT


## Quickstart

Install:

```shell
pip install ringba-api-client
```

Import:

```python
from ringba_api_client import RingbaApiClient
```

Initialize:

```python
ringba = RingbaApiClient(api_key='XXXXXXXXXXXXXXXX')
```

Use:

```python
target = ringba.get_targets(target_id='abdc12345')
```


## TODO:

- Add schema validation for create/update bodies


## Credits

This package was created with [Cookiecutter][cookiecutter] and the [fedejaure/cookiecutter-modern-pypackage][cookiecutter-modern-pypackage] project template.

[cookiecutter]: https://github.com/cookiecutter/cookiecutter
[cookiecutter-modern-pypackage]: https://github.com/fedejaure/cookiecutter-modern-pypackage

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nat5142/ringba-api-client",
    "name": "ringba-api-client",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<3.12",
    "maintainer_email": "",
    "keywords": "ringba-api-client",
    "author": "Nick Tulli",
    "author_email": "ntulli.dev@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/47/b7/c22dc7b138786c9b2a1adbb2b143703e5d3e74db79b56755ff385bb8e49b/ringba_api_client-0.0.1.tar.gz",
    "platform": null,
    "description": "\n# Ringba API Client\n\n\n<div align=\"center\">\n\n[![PyPI - Version](https://img.shields.io/pypi/v/ringba-api-client.svg)](https://pypi.python.org/pypi/ringba-api-client)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ringba-api-client.svg)](https://pypi.python.org/pypi/ringba-api-client)\n[![Tests](https://github.com/nat5142/ringba-api-client/workflows/tests/badge.svg)](https://github.com/nat5142/ringba-api-client/actions?workflow=tests)\n[![Codecov](https://codecov.io/gh/nat5142/ringba-api-client/branch/main/graph/badge.svg)](https://codecov.io/gh/nat5142/ringba-api-client)\n[![Read the Docs](https://readthedocs.org/projects/ringba-api-client/badge/)](https://ringba-api-client.readthedocs.io/)\n[![PyPI - License](https://img.shields.io/pypi/l/ringba-api-client.svg)](https://pypi.python.org/pypi/ringba-api-client)\n\n[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)\n\n\n</div>\n\n\nSimple Rrequest package to integrate with the Ringba Public API\n\n\n* GitHub repo: <https://github.com/nat5142/ringba-api-client.git>\n* Documentation: <https://ringba-api-client.readthedocs.io>\n* Free software: MIT\n\n\n## Quickstart\n\nInstall:\n\n```shell\npip install ringba-api-client\n```\n\nImport:\n\n```python\nfrom ringba_api_client import RingbaApiClient\n```\n\nInitialize:\n\n```python\nringba = RingbaApiClient(api_key='XXXXXXXXXXXXXXXX')\n```\n\nUse:\n\n```python\ntarget = ringba.get_targets(target_id='abdc12345')\n```\n\n\n## TODO:\n\n- Add schema validation for create/update bodies\n\n\n## Credits\n\nThis package was created with [Cookiecutter][cookiecutter] and the [fedejaure/cookiecutter-modern-pypackage][cookiecutter-modern-pypackage] project template.\n\n[cookiecutter]: https://github.com/cookiecutter/cookiecutter\n[cookiecutter-modern-pypackage]: https://github.com/fedejaure/cookiecutter-modern-pypackage\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Simple Rrequest package to integrate with the Ringba Public API",
    "version": "0.0.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/nat5142/ringba-api-client/issues",
        "Documentation": "https://ringba-api-client.readthedocs.io",
        "Homepage": "https://github.com/nat5142/ringba-api-client",
        "Repository": "https://github.com/nat5142/ringba-api-client"
    },
    "split_keywords": [
        "ringba-api-client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "74e8e294af0e7c4b47de03cbefd8889dc2aed9db1f48b70fe7358e08158c788d",
                "md5": "762b6c79c42fd125c4a96fa522d49362",
                "sha256": "554737b030e274f5908aa2cd3c1a092500affb502d8ba308067fd773980b98ec"
            },
            "downloads": -1,
            "filename": "ringba_api_client-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "762b6c79c42fd125c4a96fa522d49362",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<3.12",
            "size": 5661,
            "upload_time": "2024-02-09T21:59:23",
            "upload_time_iso_8601": "2024-02-09T21:59:23.734536Z",
            "url": "https://files.pythonhosted.org/packages/74/e8/e294af0e7c4b47de03cbefd8889dc2aed9db1f48b70fe7358e08158c788d/ringba_api_client-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "47b7c22dc7b138786c9b2a1adbb2b143703e5d3e74db79b56755ff385bb8e49b",
                "md5": "cbd0f6a18e362253d0575782848f503e",
                "sha256": "171cea9c3ffd9cc31f1c3593502637e738d79f4b5a2944421f5827020099759b"
            },
            "downloads": -1,
            "filename": "ringba_api_client-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "cbd0f6a18e362253d0575782848f503e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<3.12",
            "size": 6390,
            "upload_time": "2024-02-09T21:59:25",
            "upload_time_iso_8601": "2024-02-09T21:59:25.541292Z",
            "url": "https://files.pythonhosted.org/packages/47/b7/c22dc7b138786c9b2a1adbb2b143703e5d3e74db79b56755ff385bb8e49b/ringba_api_client-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-09 21:59:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nat5142",
    "github_project": "ringba-api-client",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ringba-api-client"
}
Nick Tulli
Elapsed time: 0.21167s