Metadata-Version: 2.1
Name: discogspy
Version: 0.1.2
Summary: A set of wrapper and tools to make use of the discogs api
Home-page: https://github.com/cpow-89/discogspy
Author: cpow-89
Author-email: christoph_powazny@gmx.de
License: Apache Software License 2.0
Keywords: python discogs requests api
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: jupyter
Requires-Dist: requests
Requires-Dist: responses

<!--

#################################################
### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
#################################################
# file to edit: nbs/index.ipynb
# command to build the docs after a change: nbdev_build_docs

-->

# Discogspy

> Discogspy is a  type-safe and easy to use python wrapper around the Discogs API.


Important: This package is under substantial development. See Road Map for more information.

## Install

`pip install discogspy`


## Road Map

1. Create type save python wrapper around the Discogs API

    a) Wrap database calls (done - except search request cause I personally dont have any usecase for it)<br>
    b) Wrap marketplace calls<br>
    c) Wrap inventory export calls<br>
    d) Wrap inventory upload calls<br>
    e) Wrap user identity calls<br>
    f) Wrap user collection calls<br>
    g) Wrap user wantlist calls<br>
    h) Wrap user lists calls<br>

2. Create response wrapper

## How to use

For detailed explanation please visit the [documentation](https://cpow-89.github.io/discogspy/).

Currently, you have two options for starting requests to Discogs.

1. Create a user object without authentication. This will limit your options cause a lot of api calls require authentication.
<div class="codecell" markdown="1">
<div class="input_area" markdown="1">

```python
from discogspy.core.discogs_user import UserWithoutAuthentication
from discogspy.core import rq_database

user = UserWithoutAuthentication()
resp = rq_database.get_release(user, 1972502)
```

</div>

</div>

2. Create a user object with user token authentication. This will allow you to send any request.
<div class="codecell" markdown="1">
<div class="input_area" markdown="1">

```python
from discogspy.core.discogs_user import UserWithUserTokenBasedAuthentication
from discogspy.core import rq_database

user_with_authentication = UserWithUserTokenBasedAuthentication(user_token="your_user_token",
                                                                user_agent="your_user_agent")
resp = rq_database.get_release(user, 1972502)
```

</div>

</div>


