---

This script is no longer maintained, see an up-to-date version here

---

Mx3's Publishr

A script to automate the tedious process of getting music out, currently in construction.

Currently supported features

• Cover arts square auto-creation (by cropping)
• Renaming of audio files following a scheme
• CLI log types dynamically created, see LOG_TYPES in consts.py
• Automatic video generation from audiofiles and cover art
• .zip Full Album archive creation
• Twitter posting
• Uploading to a website's database
• Uploading to website filesystem (local and remote)

Roadmap

Main objectives

• Auto track renaming
• Square cover art creation
• Auto video generation
• Auto apply metadata
• .zip Full Album archive creation
• Upload to YouTube
• Upload to my website's filesystem
• Upload to my website's database
• Send a newsletter
• Publish a post on twitter
• Log all info to a latest.log file

/!\ Readme imported from my personnal trello card's description

Processing

INPUTS

• Filename
• Artist (SELF_NAME by default) ¤
• Track kind (album, ep, remix or single)
• Collection name ¤
• Description ¤
  • French
  • English
• Cover art
  • Landscape version
  • Square version (cropped landscape version if not provided)
• Video (auto-generated w/ fade in&out, using landscape cover if not provided)

¤ means explicitly added by user else implicitly fetched with predetermined paths & filenaming schemes

FILES CREATED

• Lowres cover art versions
• Full Album zip file (if its a collection)

DATA UPLOADED

• Database
• Social networks (using buffer)
  • Cover arts (FB/TW:Landscape/IG:Square, with button "out now" added)
• Website filesystem
  • Cover arts
  • Full album
  • Audio file(s)
• YouTube (1 week delay ?)
  • Video
  • Cover art (used for thumbnail, landscape version)
• Newsletter

FILES MODIFIED

• audio file (adds ID3 tags)
• wav files (converted to mp3)

Resources

NOTES

• Upload duration of tracks (and array of durations of tracknames if track is a collection) to DB in order to levrage server resources usage

RESOURCES

• Twitter API
• Facebook API
• Instagram API
• YouTube Data API
• mx3creations.com's musiclist database table (through API ?)

PYTHON CONCEPTS

• File object
• HTTP Request (cURL ?)
• Image operations
• Video operations
• ID3 Tags operations
• Database operations
• CLI Progress bars ?
• Regex
• FTP (or SSH ?)
• WAV to MP3 conversion

NAMING SCHEMES

• Cover arts : <collection> cover art (<landscape|square>).png
• Songs/Videos filenames : <artist> - <trackname>.<mp3|mp4>

Commit naming convention

<type>(<scope>): <subject>
<NEWLINE>
<description>
<NEWLINE>
<footer>

types:

• feat: new feature
• docs: documentation
• fix : bug fixed
• refactor: refactoring (changing code without affecting functionnality)
• style: minor refactoring, for code style only (eg. changed variable name, use objects instead of dicts...)
• dep: dependencies add/remove dependencides
• conf: changing config files
• ui: fixing typos or improving CLI/GUI
• log: add/remove logging
• struct: structural/organizational changes, not big enough to be considered a refactoring.
• prep: Addition of classes/methods/functions/stuff in anticipation for future features
• misc: this should eventually go away, it stays while I define other types I need.