RTFD-test

Pypi Documentation Status Python Versions License

Contents

Install

You can install the program with the following command:

pip install yt2mp3

Usage

The program can be executed via the as follows:

yt2mp3 [-options]

Options

+======================+=======================================================+ | -t, --track | Specify the track name query | +———————-+——————————————————-+ | -a, --artist | Specify the artist name query | +———————-+——————————————————-+ | -u, --url | Specify a Youtube URL or ID | +———————-+——————————————————-+ | -p, --playlist | Specify a Youtube playlist URL or ID | +———————-+——————————————————-+ | -o, --overwrite | Overwrite the file if one exists in output directory | +———————-+——————————————————-+ | -q, --quiet | Suppress program command-line output | +———————-+——————————————————-+ | -v, --verbose | Display a command-line progress bar | +———————-+——————————————————-+ | --version | Show the version number and exit | +———————-+——————————————————-+ | -h, --help | Display information on usage and functionality | +———————-+——————————————————-+

*Note:* Displaying the progress bar currently has a significant impact on download performance, due to #180_.

Usage Example

Development

If you’d like to contribute to the project, you can download and install the program with the following commands:

# Clone the repository / most up to date is on saftyBranch
git clone https://github.com/tterb/yt2mp3

# Navigate to the directory
cd yt2mp3

# Install program dependencies
pip install -r requirements.txt

Changelog

Version 1.1.0

  • Added support for playlists
  • Improved command-line option functionality
  • Added duplicate check and overwrite command-line option

Version 1.0.5

  • Added additional error-handling
  • Improved song data acquisition for YouTube URLs
  • Improved command-line option functionality
  • Added additional project documentation
  • Fixed issue with missing executable from PyPi

Version 1.0.2

  • Published package to PyPi

Version 1.0.0

  • All features added
  • All bugs created

The MIT License (MIT)

Copyright (c) 2018 Brett Stevenson <bstevensondev@gmail.com>

MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

License taken from MIT license.

Indices and tables