Metadata-Version: 2.1
Name: pbwrap
Version: 1.0.6
Summary: A Pastebin API Wrapper for Python
Home-page: https://github.com/Mikts/pbwrap
Author: Michael Tsoukatos
Author-email: mikts94@gmail.com
License: MIT
Project-URL: Bug Reports, https://github.com/Mikts/pbwrap/issues
Keywords: wrapper pastebin api development utility
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3
Description-Content-Type: text/x-rst
Provides-Extra: test
Requires-Dist: requests
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'

# Pastebin API wrapper for Python (pbwrap)
[![PyPI version](https://badge.fury.io/py/pbwrap.svg)](https://badge.fury.io/py/pbwrap)
[![Build Status](https://travis-ci.org/Mikts/pbwrap.svg?branch=master)](https://travis-ci.org/Mikts/pbwrap)
[![Coverage Status](https://coveralls.io/repos/github/Mikts/pbwrap/badge.svg)](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/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)


