Exports your Discogs collection or wantlist into a xlsx file.
Project description
discogs2xlsx
Export your Discogs collection or wantlist into a xlsx file.
Synopsis
This tool will try to export your collection or wantlist from Discogs into
a .xlsx
file.
The time required to perform the export will depend on the size of your collection, or wantlist. Discogs requests to the API are throttled to 60 per minute for authenticated requests, for that reason for large collections, or wantlists, the export can take hours to perform.
Prerequisites
There are a couple of things needed for the tool to work.
Python, version 3.9 or above, needs to be installed on your local computer. You will also need a Discogs account.
Discogs
A Discogs user account is required (to obtain the ratings from). You can create an account at https://www.discogs.com/users/create if you do not have one already.
A Discogs personal token is also required. You can obtain one at https://www.discogs.com/settings/developers
For price recommendations (--prices
option) the
Discogs Seller Settings are
required.
Python 3.x
Python version 3.9 or above is required for the tool to work. Python setup can be found here.
The following python modules are also required to run the tool:
- progress >= 1.5
- requests >= 2.25.1
- xlsxwriter >= 3.0.0
Installation
The simplest way to install this tool is using pip:
pip3 install discogs2xlsx
Usage
A simple example of how to use this tool:
discogs2xlsx -t my_discogs_secret_token
List of all the options:
usage: discogs2xlsx [-h] [-c [{AUD,BRL,CAD,CHF,EUR,GBP,JPY,MXN,NZD,SEK,USD,ZAR}]] [--debug] [-d] [-f [FILE]] [-p] [-q]
-t [TOKEN] [-v] [-w]
options:
-h, --help show this help message and exit
-c [{AUD,BRL,CAD,CHF,EUR,GBP,JPY,MXN,NZD,SEK,USD,ZAR}], --currency [{AUD,BRL,CAD,CHF,EUR,GBP,JPY,MXN,NZD,SEK,USD,ZAR}]
currency for prices (default: EUR)
--debug debug mode (default: False)
-d, --details exports extra details (default: False)
-f [FILE], --file [FILE]
output file name (default: discogs-collection.xlsx)
-p, --prices exports recommended prices (default: False)
-q, --quiet quiet mode (default: False)
-t [TOKEN], --token [TOKEN]
discogs token (can also be set usibg the DISCOGS_TOKEN environment variable) (default: None)
-v, --version show program's version number and exit
-w, --wantlist exports the wantlist instead of the collection (default: False)
IMPORTANT
Discogs Seller Settings are required
for the recommended prices option (-p
--prices
).
Build (from source)
It is recommended the use of a Python Virtual Environment (venv) to build this tool. The same Virtual Environment can also be used to run the tool.
All of the commands described bellow are to be executed on the root folder of this project.
A Virtual Environment can be created using the follow command:
python3 -m venv .venv/
After creating the Virtual Environment the same will have to be activated, run the following command to do that:
source venv/bin/activate
To build and run the tool some Python modules are required. These modules can be installed using the following command:
pip3 --quiet install --upgrade --requirement requirements.txt build
Finaly the Python package for this tool can be created with the command:
python3 -m build --wheel
After this you should endup with a wheel file (*.whl
) inside a folder called
dist
.
The tool can be install using the wheel file and pip3:
pip3 --quiet install dist/discogs2xlsx-*.whl
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
Please read the CONTRIBUTING.md file for more details on how to contribute to this project.
Versioning
This project uses SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Frederico Martins - fscm
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE file for details
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for discogs2xlsx-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da7490dc53545b4ae471ad797741078618a674ecb4d8f4f47eb71c956d450c84 |
|
MD5 | 25a32e7ab0ec8ac400671c5b8927f4a0 |
|
BLAKE2b-256 | 3e9421d2e33f48d762c26581ceeb03f96de94b0bc84dc10ff63c67593c0dbf17 |