Contents

Music Album Creator - CLI Application

Music Album Creator is a CLI application aiming to automate the process of building an offline music digital library.

Featuring

  • Automatically downloading and converting to mp3 from youtube
  • Segmeneting albums into tracks and automatically adding metadata information (ie for ‘artist’, ‘album’, ‘track_name’ fields)
  • Cross-platform support (Linux/Windows)
  • Cross-python support (Python2.7 or newer)

Overview

tests
Travis-CI Build Status
Appveyor Build Status
Coverage Status
Code Quality
Code Intelligence
package
PyPI Package latest release PyPI Wheel Supported versions
Commits since latest release
  • Free software: GNU General Public License v3.0

Installation

Music Album Creator requires the ffmpeg package in order to run. You can download it from https://www.ffmpeg.org/download.html.
For Linux (Debian) you can simply install it with
sudo apt-get install ffmpeg

To install the Music Album Creator simpy do

pip install music-album-creation

Usage

To run, simply execute:

create-album

Development

To run all tests run:

pip install -U tox
tox -v

Installation

At the command line:

pip install music-album-creation

Usage

To use music_album_creation in a project:

import music_album_creation

Reference

pr1

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Documentation improvements

Music Album Creator could always use more documentation, whether as part of the official Music Album Creator docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/boromir674/music-album-creator/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up Music Album Creator for local development:

  1. Fork Music Album Creator (look for the “Fork” button).

  2. Clone your fork locally:

    git clone git@github.com:boromir674/music-album-creator.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  4. When you’re done making changes run all the checks and docs builder with tox one command:

    tox

  5. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox) [1].
  2. Update documentation when there’s new API, functionality etc.
  3. Add a note to CHANGELOG.rst about the changes.
  4. Add yourself to AUTHORS.rst.
[1]

If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.

It will be slower though …

Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox

Authors

Changelog

1.3.1 (2019-11-02)

  • fix for python2.7

1.3.0 (2019-11-01)

feature

  • support python2.7

1.2.1 (2019-10-14)

Changes

  • Fix identation error

1.2.0 (2019-10-13)

Changes

  • Write integration test
  • Fix 3 minor security issues and 2 medium
  • Implement alternative method to retrieve album name
  • Improve ‘front-end’ architecture

1.1.4 (2019-07-28)

Changes

  • Fix track segmentation in linux systems.
  • Settle for 9 minor and 3 medium issues of security severity

1.1.3 (2019-07-27)

Changes

  • Improve security

1.1.1 (2019-07-21)

Changes

  • Enable Appveyor CI build trigerring for windows platform.
  • Use tox as ‘front-end’ for testing (locally/Travis-Ci/Appveyor)
  • Improve test coverage

1.0.7a (2019-07-08)

Changes

  • Add a universal wheel

1.0.7 (2019-07-08)

Changes:

Initial release.

Indices and tables