Metadata-Version: 2.1
Name: music-album-creation
Version: 1.4.0
Summary: A CLI application intending to automate offline music library building
Home-page: https://github.com/boromir674/music-album-creator
License: AGPL-3.0-only
Keywords: youtube,download,music,automation,metadata,cli,python package
Author: Konstantinos Lampridis
Author-email: k.lampridis@hotmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Home Automation
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Multimedia :: Video :: Conversion
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Software Distribution
Classifier: Typing :: Typed
Provides-Extra: docs
Provides-Extra: notebook
Provides-Extra: test
Provides-Extra: typing
Requires-Dist: attrs (>=22.1.0,<23.0.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: jupyter (>=1.0.0,<2.0.0) ; extra == "notebook"
Requires-Dist: matplotlib (>=3.6.2,<4.0.0) ; extra == "notebook"
Requires-Dist: mutagen (>=1.46.0,<2.0.0)
Requires-Dist: mypy (>=1.1.1,<2.0.0) ; extra == "typing"
Requires-Dist: prompt-toolkit (>=3.0.33,<4.0.0) ; extra == "notebook"
Requires-Dist: pyreadline (>=2.1,<3.0)
Requires-Dist: pytest (>=7.2.0,<8.0.0) ; extra == "test"
Requires-Dist: pytest-click (>=1.1.0,<2.0.0) ; extra == "test"
Requires-Dist: pytest-cov (>=4.0.0,<5.0.0) ; extra == "test"
Requires-Dist: pytest-explicit (>=1.0.1,<2.0.0) ; extra == "test"
Requires-Dist: pytest-object-getter (>=1.0.2,<2.0.0) ; extra == "test"
Requires-Dist: pytest-run-subprocess (>=0.10.0,<0.11.0) ; extra == "test"
Requires-Dist: pytest-xdist (>=3.1.0,<4.0.0) ; extra == "test"
Requires-Dist: pytube (>=12.1.2,<13.0.0)
Requires-Dist: questionary (>=1.10.0,<2.0.0)
Requires-Dist: software-patterns (>=2.0.0,<3.0.0)
Requires-Dist: tqdm (>=4.64.1,<5.0.0)
Requires-Dist: youtube_dl (>=2021.12.17,<2022.0.0)
Project-URL: Bug Tracker, https://github.com/boromir674/music-album-creator/issues
Project-URL: CI: Github Actions, https://github.com/boromir674/music-album-creator/actions
Project-URL: Changelog, https://github.com/boromir674/music-album-creator/blob/master/CHANGELOG.rst
Project-URL: Code of Conduct, https://github.com/boromir674/music-album-creator/blob/master/CONTRIBUTING.rst
Project-URL: Documentation, https://music-album-creator.readthedocs.io/
Project-URL: Repository, https://github.com/boromir674/music-album-creator
Project-URL: Source Code, https://github.com/boromir674/music-album-creator
Description-Content-Type: text/x-rst

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
- Segmenting 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
========

.. start-badges

.. list-table::
    :stub-columns: 1

    * - tests
      - | |travis|
        | |appveyor|
        | |coverage|
        | |docs|
        | |scrutinizer_code_quality|
        | |code_intelligence_status|
    * - package
      - | |version| |wheel| |supported_versions|
        | |commits_since|


.. |docs| image:: https://readthedocs.org/projects/music-album-creator/badge/?version=dev
    :target: https://music-album-creator.readthedocs.io/en/latest/?badge=dev
    :alt: Documentation Status

.. |travis| image:: https://api.travis-ci.org/boromir674/music-album-creator.svg?branch=dev
    :alt: Travis-CI Build Status
    :target: https://travis-ci.org/boromir674/music-album-creator

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/0lq9l96dwc6aq33j/branch/dev?svg=true
    :alt: Appveyor Build Status
    :target: https://ci.appveyor.com/project/boromir674/music-album-creator/branch/dev

.. |coverage| image:: https://codecov.io/gh/boromir674/music-album-creator/branch/dev/graph/badge.svg
  :alt: Coverage Status
  :target: https://codecov.io/gh/boromir674/music-album-creator

.. |scrutinizer_code_quality| image:: https://scrutinizer-ci.com/g/boromir674/music-album-creator/badges/quality-score.png?b=dev
    :alt: Code Quality
    :target: https://scrutinizer-ci.com/g/boromir674/music-album-creator/?branch=dev

.. |code_intelligence_status| image:: https://scrutinizer-ci.com/g/boromir674/music-album-creator/badges/code-intelligence.svg?b=dev
    :alt: Code Intelligence
    :target: https://scrutinizer-ci.com/code-intelligence

.. |version| image:: https://img.shields.io/pypi/v/music-album-creation.svg
    :alt: PyPI Package latest release
    :target: https://pypi.org/project/music-album-creation

.. |wheel| image:: https://img.shields.io/pypi/wheel/music-album-creation.svg
    :alt: PyPI Wheel
    :target: https://pypi.org/project/music-album-creation

.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/music-album-creation.svg
    :alt: Supported versions
    :target: https://pypi.org/project/music-album-creation

.. |commits_since| image:: https://img.shields.io/github/commits-since/boromir674/music-album-creator/v1.7.5.svg
    :alt: Commits since latest release
    :target: https://github.com/boromir674/music-album-creator/compare/v1.7.5...master


.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/music-album-creator.svg
    :alt: Supported implementations
    :target: https://pypi.org/project/music-album-creator


.. end-badges

* 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 simply do

::

    pip install music-album-creation


Usage
============

To run, simply execute::

    create-album


Documentation
=============


https://music-album-creator.readthedocs.io/


Development
===========

To run all tests run::

    pip install -U tox
    tox -v

