AudibleSeriesChecker/readme.md

54 lines
No EOL
1.3 KiB
Markdown

# Audible Series Checker
Audible Series Checker is a Python tool for comparing audiobook series between your ABS library and Audible, helping you track missing tomes and release dates.
## Features
- Connects to ABS and Audible APIs
- Compares series and book sequences
- Identifies missing books in your library
- Supports rate-limited requests and authentication
- Logs results and errors
## Requirements
See [requirements.txt](requirements.txt) for dependencies. Install with:
```sh
pip install -r requirements.txt
```
## Configuration
Copy [.env.example](.env.example) to `.env` and fill in your credentials:
## Usage
Run the main script:
```sh
python main.py
```
Logs are written to the `log` file.
### Feature-specific Arguments
- `--non-series`
Include non-series books (books not part of a numbered series).
- `--oncoming`
Show books that are yet to be released.
## Project Structure
- [main.py](main.py): Entry point and main logic
- [config.py](config.py): Loads environment variables
- [connectors/](connectors/): API connectors for ABS, Audible, and AudNexus
- [requirements.txt](requirements.txt): Python dependencies
## Development
- Mock connectors are available for testing (see `*Mock` classes in [connectors/](connectors/))
- Logging is configured in [main.py](main.py)
- Environment variables are loaded via [config.py](config.py)