# Pastebin API wrapper for Python (pbwrap)
[](https://badge.fury.io/py/pbwrap)
[](https://travis-ci.org/Mikts/pbwrap)
[](https://coveralls.io/github/Mikts/pbwrap)
>**Python API wrapper for the Pastebin Public API.
**Only _Python 3_ supported!**
## Documentation
This wrapper is based on **Pastebin** API read their Documentation [**here.**](https://pastebin.com/doc_api)
for extra information and usage guide.
### Usage
For a full list of the methods offered by the package [**Read.**](http://pbwrap.readthedocs.io/en/latest/)
#### Quickstart
Import and instantiate a Pastebin Object.
```Python
from pbwrap import Pastebin
pastebin = Pastebin(api_dev_key)
```
### Examples
##### Get User Id
Returns a string with the user_id created after authentication.
```Python
user_id = pastebin.authenticate(username, password)
```
##### Get Trending Pastes details
Returns a list containing Paste objects of the top 18 trending Pastes.
```Python
trending_pastes = pastebin.get_trending()
```
### Type models
#### Paste
Some API endpoints return paste data in xml format the wrapper either converts them in a python dictionary format
or returns them as Paste objects which contain the following fields:
* **key**
* **date** in **_UNIXTIME_**
* **title**
* **size**
* **expire_date**
* **private**
* **format_short**
* **format_long**
* **url**
* **hits**
## License
pbwrap is released under [**MIT License**](./LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/Mikts/pbwrap",
"name": "pbwrap",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.2,<4.0",
"maintainer_email": "",
"keywords": "pastebin,pbwrap,wrapper,api",
"author": "Mikts",
"author_email": "mikts94@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c9/97/c7103dce726ba7ac23e52af70bbf9f56d743499d1eea975c581f700b43b4/pbwrap-1.4.0.tar.gz",
"platform": null,
"description": "# Pastebin API wrapper for Python (pbwrap)\n[](https://badge.fury.io/py/pbwrap)\n[](https://travis-ci.org/Mikts/pbwrap)\n[](https://coveralls.io/github/Mikts/pbwrap)\n\n\n>**Python API wrapper for the Pastebin Public API. \n**Only _Python 3_ supported!**\n\n## Documentation\n\nThis wrapper is based on **Pastebin** API read their Documentation [**here.**](https://pastebin.com/doc_api) \nfor extra information and usage guide.\n\n### Usage\nFor a full list of the methods offered by the package [**Read.**](http://pbwrap.readthedocs.io/en/latest/)\n\n#### Quickstart\nImport and instantiate a Pastebin Object.\n```Python\nfrom pbwrap import Pastebin\n\npastebin = Pastebin(api_dev_key)\n```\n\n### Examples\n\n##### Get User Id\nReturns a string with the user_id created after authentication.\n```Python\nuser_id = pastebin.authenticate(username, password)\n```\n\n##### Get Trending Pastes details\nReturns a list containing Paste objects of the top 18 trending Pastes.\n\n```Python\ntrending_pastes = pastebin.get_trending()\n```\n\n### Type models\n\n#### Paste\n\nSome API endpoints return paste data in xml format the wrapper either converts them in a python dictionary format \nor returns them as Paste objects which contain the following fields:\n\n* **key**\n* **date** in **_UNIXTIME_**\n* **title**\n* **size**\n* **expire_date**\n* **private**\n* **format_short**\n* **format_long**\n* **url**\n* **hits**\n\n## License\npbwrap is released under [**MIT License**](./LICENSE)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Pastebin API Wrapper for Python",
"version": "1.4.0",
"split_keywords": [
"pastebin",
"pbwrap",
"wrapper",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6be6e47207134607ce27c6c91027812df0552aef9372690a395f3517c3a9d85c",
"md5": "d745ef78e521e18467c15680dddfbc3b",
"sha256": "7ed1408b9dbd996c2cc600d4f7ad5c8960d9e9707e52285a59902f358b3903f4"
},
"downloads": -1,
"filename": "pbwrap-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d745ef78e521e18467c15680dddfbc3b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.2,<4.0",
"size": 8793,
"upload_time": "2023-02-06T06:33:26",
"upload_time_iso_8601": "2023-02-06T06:33:26.787847Z",
"url": "https://files.pythonhosted.org/packages/6b/e6/e47207134607ce27c6c91027812df0552aef9372690a395f3517c3a9d85c/pbwrap-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c997c7103dce726ba7ac23e52af70bbf9f56d743499d1eea975c581f700b43b4",
"md5": "bc6ecda08fd9a16f5ad1b33111fae53b",
"sha256": "8100153fd2ca1e366a912c579ba28f320e36908fc85e8f2678789a9be5027172"
},
"downloads": -1,
"filename": "pbwrap-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "bc6ecda08fd9a16f5ad1b33111fae53b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.2,<4.0",
"size": 7572,
"upload_time": "2023-02-06T06:33:28",
"upload_time_iso_8601": "2023-02-06T06:33:28.915487Z",
"url": "https://files.pythonhosted.org/packages/c9/97/c7103dce726ba7ac23e52af70bbf9f56d743499d1eea975c581f700b43b4/pbwrap-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-06 06:33:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Mikts",
"github_project": "pbwrap",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "pbwrap"
}
JSON
