Metadata-Version: 2.1
Name: xkcd-python
Version: 2.8.0
Summary: A wrapper for xkcd.com's API. Built Using Python.
License: MIT
Author: Sasen Perera
Author-email: sasen.learnings@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: Pygments (==2.12.0)
Requires-Dist: atomicwrites (==1.4.0)
Requires-Dist: attrs (==21.4.0)
Requires-Dist: bleach (==5.0.0)
Requires-Dist: certifi (==2022.6.15)
Requires-Dist: charset-normalizer (==2.0.12)
Requires-Dist: colorama (==0.4.5)
Requires-Dist: commonmark (==0.9.1)
Requires-Dist: docutils (==0.18.1)
Requires-Dist: idna (==3.3)
Requires-Dist: importlib-metadata (==4.11.4)
Requires-Dist: iniconfig (==1.1.1)
Requires-Dist: keyring (==23.6.0)
Requires-Dist: packaging (==21.3)
Requires-Dist: pkginfo (==1.8.3)
Requires-Dist: pluggy (==1.0.0)
Requires-Dist: py (==1.11.0)
Requires-Dist: pyparsing (==3.0.9)
Requires-Dist: pytest (==7.1.2)
Requires-Dist: pywin32-ctypes (==0.2.0)
Requires-Dist: readme-renderer (==35.0)
Requires-Dist: requests (==2.28.0)
Requires-Dist: requests-toolbelt (==0.9.1)
Requires-Dist: rfc3986 (==2.0.0)
Requires-Dist: rich (==12.4.4)
Requires-Dist: six (==1.16.0)
Requires-Dist: tomli (==2.0.1)
Requires-Dist: twine (==4.0.1)
Requires-Dist: urllib3 (==1.26.9)
Requires-Dist: webencodings (==0.5.1)
Requires-Dist: zipp (==3.8.0)
Description-Content-Type: text/markdown

# xkcd-python

xkcd-python is an API wrapper for xkcd.com written in python.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.

```bash
pip install -U xkcd-python
```

## Usage

```python
from xkcd_python import *

#creates the client
client = Client()

# returns the comic by id
client.get(1)

# returns a random comic
client.random()

# returns the latest comic
client.latest_comic()
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[MIT](https://github.com/Sas2k/xkcd-python/blob/main/LICENSE)
