Welcome to the DJ Automation CLI! This powerful tool streamlines your DJ workflow by automating tasks such as downloading tracks, organizing files, generating AI covers, and uploading mixes to Mixcloud. Whether you're managing a personal collection or handling large-scale uploads, this CLI has got you covered. 🚀
LAST UPDATE 1/13/25: Documentation will be updated with the correct details. Many of the functions still work as intended.
- Automated Downloads: Fetch audio tracks from various sources effortlessly.
- File Organization: Automatically organize your downloads for easy access.
- AI Cover Generation: (Coming Soon) Create stunning AI-generated covers for your mixes.
- Mixcloud Integration: Seamlessly upload your mixes to Mixcloud with OAuth authentication.
- Scheduling: Schedule uploads to publish your mixes at optimal times.
- Robust Testing: Ensure reliability with comprehensive automated tests.
- Colorful CLI: Enjoy an intuitive and visually appealing command-line interface with color-coded messages. 🎨
DJAutomation/
│
├── cli/
│ ├── main.py # Main CLI entry point
│ └── test_cli.py # CLI for running tests
│
├── config/
│ ├── settings.py # Configuration settings
│ └── mixcloud/
│ └── settings.py # Mixcloud-specific configurations
│
├── core/
│ └── color_utils.py # Utilities for colored CLI messages
│
├── modules/
│ ├── download/
│ │ ├── downloader.py # Module for downloading tracks
│ │ └── post_process.py # Module for organizing downloaded files
│ │
│ └── mixcloud/
│ ├── uploader.py # Module for uploading to Mixcloud
│ ├── scheduler.py # Module for scheduling uploads
│ └── cli.py # CLI-specific functions for Mixcloud
│
├── tests/
│ └── test_mixcloud.py # Tests for Mixcloud uploader
│
├── .env # Environment variables (not committed)
├── requirements.txt # Python dependencies
└── README.md # Project documentation
All sensitive credentials and environment-specific settings are managed through the .env file. Ensure this file is listed in your .gitignore to prevent accidental commits of sensitive information.
# .env
# Only store API keys or other sensitive credentials here.
# Example placeholders have been left blank. Fill in as needed.
# Mixcloud OAuth
MIXCLOUD_CLIENT_ID=""
MIXCLOUD_CLIENT_SECRET=""
# Spotify
SPOTIFY_CLIENT_ID=""
SPOTIFY_CLIENT_SECRET=""
# Last.fm
LASTFM_API_KEY=""
# Deezer
DEEZER_API_KEY=""
# MusicBrainz
MUSICBRAINZ_API_TOKEN=""Centralized configuration file that imports environment variables and sets default values.
• Paths: Directories for tracks, covers, finished uploads, etc.
• API Credentials: Client IDs and secrets for Mixcloud, Spotify, etc.
• Upload Parameters: Maximum uploads per run, publish times, and tags.
• Toggles: Enable or disable features like Mixcloud integration and color logs.
-
Clone the Repository:
git clone https://github.com/Katazui/DJAutomation.git cd DJAutomation -
Create a Virtual Environment (optional but recommended):
python3 -m venv venv source venv/bin/activate -
Install Dependencies:
pip install -r requirements.txt -
Configure Environment Variables:
• Create a
.envfile in the root directory.• Populate it with the necessary credentials and paths as shown in the Configuration section.
TODO
TODO
Run all tests or specific ones (e.g. Mixcloud tests, Album Cover, Downloads, etc).
python cli/main.py test
python cli/main.py test --mixcloud
Ensure your codebase remains robust by running automated tests.
- Run Tests via CLI:
python cli/main.py test
• All Tests: Executes all tests in the tests/ directory.
• Specific Tests: Use flags like --mixcloud to run targeted tests.
- Run Tests Directly with Pytest:
pytest tests/
- Adding New Tests:
• Create new test files in the tests/ directory following the test_*.py nameing convention.
• Ensure your tests cover different modukles and functionalities.
• downloader.py: Handles downloading audio tracks from provided links. Supports interactive and file-based modes.
• post_process.py: Organizes downloaded files into structured directories for easy management.
• uploader.py: Manages the uploading of tracks to Mixcloud, including handling OAuth authentication and file uploads.
• scheduler.py: (Future) Implements scheduling logic to automate upload timings.
• cli.py: Contains CLI-specific functions for Mixcloud integration.
• color_utils.py: Provides utilities for color-coded messages in the CLI, enhancing readability and user experience.
• settings.py: Centralized configuration file importing environment variables and setting default values.
• mixcloud/settings.py: Mixcloud-specific configurations, including API credentials and upload parameters.
• test_mixcloud.py: Contains unit and integration tests for the Mixcloud uploader module, ensuring reliability and correctness.
• Sensitive Data: All sensitive credentials (API keys, secrets) are stored in the .env file and never committed to version control.
• .gitignore: Ensure your .env file is listed in .gitignore to prevent accidental exposure.
If you encouynter any issues or have questions, feel free to reach out:
• Email: [email protected]
• GitHub Issues: Open an Issue
This project is licensed under the MIT License. See the LICENSE file for details.
Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or bug fixes.
-
Fork the Repository.
-
Create a Feature Branch:
git checkout -b feature/YourFeature
- Commit Your Changes:
git commit -m "Add Your Feature Name"
- Push to the Branch:
git push origin feature/YourFeature
- Open a Pull Request.
Stay tuned for more features and improvements! Thank you for using DJ Automation CLI. 🎉