# paspybin
[![Test](https://github.com/kiraware/paspybin/workflows/Test/badge.svg)](https://github.com/kiraware/paspybin/actions/workflows/test.yml)
[![CodeQL](https://github.com/kiraware/paspybin/workflows/CodeQL/badge.svg)](https://github.com/kiraware/paspybin/actions/workflows/codeql.yml)
[![Docs](https://readthedocs.org/projects/paspybin/badge/?version=latest)](https://paspybin.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/kiraware/paspybin/graph/badge.svg?token=PH6EUFT4V0)](https://codecov.io/gh/kiraware/paspybin)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![pypi](https://img.shields.io/pypi/v/paspybin.svg)](https://pypi.org/project/paspybin/)
[![python](https://img.shields.io/pypi/pyversions/paspybin.svg)](https://pypi.org/project/paspybin/)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/license/MIT/)
`paspybin` is an asynchronous API wrapper for the
[Pastebin API](https://pastebin.com/doc_api), designed to streamline
interaction with Pastebin's services in Python. It enables users to
leverage Pastebin's functionality asynchronously, enhancing performance
and usability.
## Key Features
- **Asynchronous Operations:** Utilizes `asyncio` and `aiohttp` for efficient API requests.
- **Data Schema:** Built with Python's `dataclass` for clear and structured data representation.
- **Comprehensive Documentation:** Explore detailed [documentation](https://paspybin.readthedocs.io/en/latest/) for seamless integration and usage.
## Installation
```bash
pip install paspybin
```
## Usage
```python
import asyncio
import os
from paspybin import Paspybin
PASTEBIN_API_DEV_KEY = os.environ["PASTEBIN_API_DEV_KEY"]
PASTEBIN_USERNAME = os.environ["PASTEBIN_USERNAME"]
PASTEBIN_PASSWORD = os.environ["PASTEBIN_PASSWORD"]
async def main():
async with Paspybin(PASTEBIN_API_DEV_KEY) as paspybin:
await paspybin.login(PASTEBIN_USERNAME, PASTEBIN_PASSWORD)
async for paste in paspybin.pastes.get_all():
print(paste)
asyncio.run(main())
```
## Docs
You can start reading the documentation [here](https://paspybin.readthedocs.io/en/latest/).
## Contributing
We welcome contributions to enhance paspybin! Please review our
[contributing guidelines](https://paspybin.readthedocs.io/en/latest/how-to-guides/#contributing).
before getting started.
## Acknowledgements
We would like to thank [Pastebin](https://pastebin.com/)
for providing API services and also good documentation for
using the API.
Raw data
{
"_id": null,
"home_page": "https://github.com/kiraware/paspybin",
"name": "paspybin",
"maintainer": "Kira",
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": "kiraware@github.com",
"keywords": "pastebin, api",
"author": "Kira",
"author_email": "kiraware@github.com",
"download_url": "https://files.pythonhosted.org/packages/fa/e8/b04fb773cb7b92546ed400cc68262f002353b70fa9260ce10261e2123cd1/paspybin-1.0.1.tar.gz",
"platform": null,
"description": "# paspybin\n\n[![Test](https://github.com/kiraware/paspybin/workflows/Test/badge.svg)](https://github.com/kiraware/paspybin/actions/workflows/test.yml)\n[![CodeQL](https://github.com/kiraware/paspybin/workflows/CodeQL/badge.svg)](https://github.com/kiraware/paspybin/actions/workflows/codeql.yml)\n[![Docs](https://readthedocs.org/projects/paspybin/badge/?version=latest)](https://paspybin.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/gh/kiraware/paspybin/graph/badge.svg?token=PH6EUFT4V0)](https://codecov.io/gh/kiraware/paspybin)\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[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![pypi](https://img.shields.io/pypi/v/paspybin.svg)](https://pypi.org/project/paspybin/)\n[![python](https://img.shields.io/pypi/pyversions/paspybin.svg)](https://pypi.org/project/paspybin/)\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/license/MIT/)\n\n`paspybin` is an asynchronous API wrapper for the\n[Pastebin API](https://pastebin.com/doc_api), designed to streamline\ninteraction with Pastebin's services in Python. It enables users to\nleverage Pastebin's functionality asynchronously, enhancing performance\nand usability.\n\n## Key Features\n\n- **Asynchronous Operations:** Utilizes `asyncio` and `aiohttp` for efficient API requests.\n- **Data Schema:** Built with Python's `dataclass` for clear and structured data representation.\n- **Comprehensive Documentation:** Explore detailed [documentation](https://paspybin.readthedocs.io/en/latest/) for seamless integration and usage.\n\n## Installation\n\n```bash\npip install paspybin\n```\n\n## Usage\n\n```python\nimport asyncio\nimport os\n\nfrom paspybin import Paspybin\n\nPASTEBIN_API_DEV_KEY = os.environ[\"PASTEBIN_API_DEV_KEY\"]\nPASTEBIN_USERNAME = os.environ[\"PASTEBIN_USERNAME\"]\nPASTEBIN_PASSWORD = os.environ[\"PASTEBIN_PASSWORD\"]\n\nasync def main():\n async with Paspybin(PASTEBIN_API_DEV_KEY) as paspybin:\n await paspybin.login(PASTEBIN_USERNAME, PASTEBIN_PASSWORD)\n async for paste in paspybin.pastes.get_all():\n print(paste)\n\nasyncio.run(main())\n```\n\n## Docs\n\nYou can start reading the documentation [here](https://paspybin.readthedocs.io/en/latest/).\n\n## Contributing\n\nWe welcome contributions to enhance paspybin! Please review our\n[contributing guidelines](https://paspybin.readthedocs.io/en/latest/how-to-guides/#contributing).\nbefore getting started.\n\n## Acknowledgements\n\nWe would like to thank [Pastebin](https://pastebin.com/)\nfor providing API services and also good documentation for\nusing the API.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Pastebin API Wrapper",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/kiraware/paspybin/issues",
"Documentation": "https://paspybin.readthedocs.io/en/latest/",
"Homepage": "https://github.com/kiraware/paspybin",
"Repository": "https://github.com/kiraware/paspybin"
},
"split_keywords": [
"pastebin",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0900ea3d6b0e369633957d7e00cff7883360da26b181d9da09ca8aefa5a88418",
"md5": "8e76b6029b8469cbd2dcde520c956b6a",
"sha256": "51163581431d71671e6e150402deab4cebe137da98d109496d50c4af4e2c78d2"
},
"downloads": -1,
"filename": "paspybin-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e76b6029b8469cbd2dcde520c956b6a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 20575,
"upload_time": "2024-07-25T04:53:20",
"upload_time_iso_8601": "2024-07-25T04:53:20.604996Z",
"url": "https://files.pythonhosted.org/packages/09/00/ea3d6b0e369633957d7e00cff7883360da26b181d9da09ca8aefa5a88418/paspybin-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fae8b04fb773cb7b92546ed400cc68262f002353b70fa9260ce10261e2123cd1",
"md5": "fcf6a11d4e2aede9f1d7d24f7785b9cd",
"sha256": "8af2e0be888e550025a659841409bf57c42669d3bcdfe7e4f3cec2296ca59996"
},
"downloads": -1,
"filename": "paspybin-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "fcf6a11d4e2aede9f1d7d24f7785b9cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 16704,
"upload_time": "2024-07-25T04:53:22",
"upload_time_iso_8601": "2024-07-25T04:53:22.101943Z",
"url": "https://files.pythonhosted.org/packages/fa/e8/b04fb773cb7b92546ed400cc68262f002353b70fa9260ce10261e2123cd1/paspybin-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-25 04:53:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kiraware",
"github_project": "paspybin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "paspybin"
}