Discogs Record Shelf Documentation

Discogs Record Shelf is a professional Python tool for creating custom reports from your Discogs music collection with intelligent sorting by shelf and alphabetical organization.

Features

📊 Multiple Output Formats

Generate detailed collection reports in Excel, CSV, or HTML format

🗂️ Smart Organization

Sort items by shelf, then alphabetically by artist and title

🔍 Flexible Filtering

Filter reports by specific shelves or generate complete collection reports

📑 Excel Integration

Export separate sheets for each shelf with professional formatting

🖥️ Command-Line Interface

Easy-to-use CLI for automation and scripting

⏱️ API Rate Limiting

Built-in rate limiting to respect Discogs API limits

📝 Comprehensive Logging

Detailed logging and error handling for troubleshooting

🧪 Full Test Coverage

Comprehensive test suite with pytest

🔧 Professional Development

Complete development setup with tox, pylint, and black

Quick Start

1. Installation:

   pip install discogs-record-shelf
   

2. Get your Discogs API token from https://www.discogs.com/settings/developers

3. Set your token:

   export DISCOGS_TOKEN="your_token_here"
   

4. Generate a report:

   record-shelf generate --username YOUR_DISCOGS_USERNAME
   

5. List available categories:

   record-shelf list-categories --username YOUR_DISCOGS_USERNAME
   

Documentation Contents

User Guide:

• Installation
  • System Requirements
  • Installation Options
  • Verification
  • Dependencies
  • Troubleshooting
  • Next Steps
• Quick Start Guide
  • Step 1: Get Your Discogs API Token
  • Step 2: Set Up Your Token
  • Step 3: Your First Report
  • Step 4: Explore Your Collection
  • Step 5: Customize Your Reports
  • Common Examples
  • Understanding the Output
  • Troubleshooting
  • Next Steps
• Usage Guide
  • Command Line Interface
  • Generate Command
  • List Shelves Command
  • Output Formats
  • Data Fields
  • Sorting and Organization
  • Rate Limiting
  • Error Handling
  • Logging
  • Advanced Usage
  • Troubleshooting
• Configuration
  • API Token Setup
  • Token Configuration
  • Advanced Configuration
  • Output Configuration
  • Filtering Configuration
  • Security Configuration
  • Performance Configuration
  • Troubleshooting Configuration
  • Development Configuration
• Output Formats
  • Format Overview
  • Excel Format (.xlsx)
  • CSV Format (.csv)
  • HTML Format (.html)
  • Choosing the Right Format
  • Multiple Format Generation
  • Customization Options
  • Troubleshooting Output Issues

API Reference:

• API Reference
  • Core Modules
  • Quick Reference
  • Usage Examples
  • Type Hints
  • Error Handling
  • Customization
  • Extending Functionality
  • Integration Examples
• CLI Module
  • Command Line Interface
  • Usage Examples
  • Command Documentation
• Config Module
  • Configuration Management
  • Usage Examples
  • Configuration Options
  • Environment Variables
  • Best Practices
• Report Generator Module
  • Report Generation
  • Usage Examples
  • Method Documentation
  • Data Processing
  • Best Practices
• Utils Module
  • Utility Functions
  • Usage Examples
  • Advanced Usage
  • Function Documentation
  • Best Practices
  • Error Handling
  • Integration Examples

Development:

• Development
  • Development Environment
  • Development Commands
  • Code Standards
  • Testing Guidelines
  • Project Structure
  • Release Process
  • Continuous Integration
• Contributing
  • Getting Started
  • Quick Start for Contributors
  • Contribution Types
  • Development Workflow
  • Code of Conduct
  • Questions?
• Changelog
  • Unreleased
  • Version 1.0.0 - TBD

Examples

Generate a complete collection report:

record-shelf generate --username myusername --output my_collection.xlsx

Filter by specific shelf:

record-shelf generate --username myusername --shelf "Vinyl" --output vinyl_only.csv --format csv

Generate HTML report with debug logging:

record-shelf --debug generate --username myusername --format html --output collection.html

Support

• Documentation: You’re reading it!

• Issues: Report bugs and feature requests on GitHub

• Email: bryan@kempville.com

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

Please respect Discogs’ Terms of Service and API rate limits when using this tool.

Indices and tables

• Index

• Module Index

• Search Page