Spotify-downloader: Release new version on PyPI

[linusg]

• [ ] Using latest version as provided on the master branch
• [ ] [Searched](https://github.com/ritiek/spotify-downloader/issues?utf8=%E2%9C%93&q=is%3Aissue) for similar issues including closed ones

What is the purpose of your issue?

• [ ] Bug
• [ ] Feature Request
• [ ] Question
• [x] Other

Description

Version should be 1.1.0, IMO. I'll write down a list of all changes, bugfixes and new features and ask for review when finished.
Useful: https://github.com/ritiek/spotify-downloader/compare/v1.0.0...master

[linusg]

BTW, we didn't update the changelog for 1.0.0 :grin: - we might encourage people to keep the Unreleased section up to date with each PR. (See https://keepachangelog.com/en/1.0.0/)

Proposed changelog is below, please have a look @ritiek @vn-ki. I'm not sure if we want to address changes like

• logging refactoring (at the moment, I did) or
• updating/adding tests (at the moment, I didn't)

I'm not sure either whether it's wise to include

• references to relevant GH issues or not (at the moment, I didn't).

At the moment I mention the authors of PRs who aren't collaborators, so not @ritiek, @vn-ki and me - seems fair to me.

Just tell me what you think, which to leave in, which to remove and maybe what I missed. Also I feel like the distinction between Fix and Change isn't that easy sometimes.

Edit: I think releasing tomorrow should work, so I chose 1.1.0 - 2018-11-13.

---

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.

[Unreleased]

Please keep this section up to date when creating a PR!

[1.1.0] - 2018-11-13

Added

• Add check for publisher tag before adding publisher id3 tag to audio file (@gnodar01)
• Embed comment metadata in .m4a
• Overwrite track file with unique tracks
• Added command line options for skipping tracks file and successful downloads file
• Added command line option for getting all artist's songs (@AlfredoSequeida)
• Add support for .m3u playlists
• Output error details when track download fails from list file (@ManveerBasra)
• Introduce usage of black (code formatter)

Changed

• Moved a lot of content from README.md to the repository's GitHub wiki.
• Refactored internal use of logging (@arryon)
• Remove duplicates from track file while preserving order
• Windows - 'My Music' folder won't be assumed to be on C drive but looked up in Registry
• Don't search song on Spotify if --no-metadata is passed (@ManveerBasra)
• Refactored Spotify token refresh (@ManveerBasra)
• Updated dependencies to their newest versions (as of 2018-10-02)
• Updated setup.py (fix PyPI URL, add Python 3.7 modifier)
• --list flag accepts only text files using mimetypes (@ManveerBasra)

Fixed

• Slugify will not ignore the ' character (single quotation mark) anymore (@jimangel2001)
• Correctly embed metadata in .m4a (@arryon)
• Place newline before track URL when appending to track file
• Check and replace slashes with dashes to avoid directory creation error (@ManveerBasra)
• Filter unwanted text from Spotify URLs when extracting information

[1.0.0] - 2018-09-09

Added

• Initial complete release, recommended way to install is now from PyPI.

1.0.0-beta.1 - 2018-02-02

Added

• Initial release, prepare for 1.0.0

[ritiek]

This looks very good! Thanks for doing this.

I'm not sure if we want to address changes like

• logging refactoring (at the moment, I did) or
• updating/adding tests (at the moment, I didn't)

Let's put them up!

I'm not sure either whether it's wise to include

• references to relevant GH issues or not (at the moment, I didn't).

At the moment I mention the authors of PRs who aren't collaborators, so not @ritiek, @vn-ki and me - seems fair to me.

We could @mention the original authors as well ;) and maybe also link to the pull request rather than issue, like the way mps-youtube does it; https://github.com/mps-youtube/mps-youtube/releases. If this sounds good, I could make changes to your comment if you don't mind. I've got some time today evening. :)

I think releasing tomorrow should work, so I chose 1.1.0 - 2018-11-13.

Yup. Let's do this!

[linusg]

Sounds good! Indeed, linking to the PR makes more sense as there isn't even always an issue - but always a PR.

[linusg]

Also I think you can't access the original markdown from my comment, so here it is:

Edit: huh, I think you can using "Edit".

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]

*Please keep this section up to date when creating a PR!*

## [1.1.0] - 2018-11-13
### Added
- Add check for publisher tag before adding publisher id3 tag to audio file ([@gnodar01](https://github.com/gnodar01))
- Embed comment metadata in .m4a 
- Overwrite track file with unique tracks
- Added command line options for skipping tracks file and successful downloads file
- Added command line option for getting all artist's songs ([@AlfredoSequeida](https://github.com/AlfredoSequeida))
- Add support for `.m3u` playlists
- Output error details when track download fails from list file ([@ManveerBasra](https://github.com/ManveerBasra))
- Introduce usage of black (code formatter)

### Changed
- Moved a lot of content from `README.md` to the [repository's GitHub wiki](https://github.com/ritiek/spotify-downloader/wiki).
- Refactored internal use of logging ([@arryon](https://github.com/arryon))
- Remove duplicates from track file while preserving order
- Windows - 'My Music' folder won't be assumed to be on C drive but looked up in Registry
- Don't search song on Spotify if `--no-metadata` is passed ([@ManveerBasra](https://github.com/ManveerBasra))
- Refactored Spotify token refresh ([@ManveerBasra](https://github.com/ManveerBasra))
- Updated dependencies to their newest versions (as of 2018-10-02)
- Updated `setup.py` (fix PyPI URL, add Python 3.7 modifier)
- `--list` flag accepts only text files using mimetypes ([@ManveerBasra](https://github.com/ManveerBasra))

### Fixed
- Slugify will not ignore the `'` character (single quotation mark) anymore ([@jimangel2001](https://github.com/jimangel2001))
- Correctly embed metadata in `.m4a` ([@arryon](https://github.com/arryon))
- Place newline before track URL when appending to track file
- Check and replace slashes with dashes to avoid directory creation error ([@ManveerBasra](https://github.com/ManveerBasra))
- Filter unwanted text from Spotify URLs when extracting information

## [1.0.0] - 2018-09-09
### Added
- Initial complete release, recommended way to install is now from PyPI.

## 1.0.0-beta.1 - 2018-02-02
### Added
- Initial release, prepare for 1.0.0

[Unreleased]: https://github.com/ritiek/spotify-downloader/compare/v1.1.0...HEAD
[1.1.0]: https://github.com/ritiek/spotify-downloader/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/ritiek/spotify-downloader/compare/v1.0.0-beta.1...v1.0.0

[ritiek]

Yep, Edit seems to allow access to raw markdown.

Okay, I've added links to authors as well and the respective PR, changed @mention to @username instead of [@username](https://github.com/username), and some minor formatting updates:

Changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.

[Unreleased]

Please keep this section up to date when creating a PR!

[1.1.0] - 2018-11-13

Added

• Add check for publisher tag before adding publisher id3 tag to audio file (@gnodar01) (#377)
• Embed comment metadata in .m4a (@ritiek) (#379)
• Overwrite track file with unique tracks (@ritiek) (#380)
• Added command line options for skipping tracks file and successful downloads file and
  place newline before track URL when appending to track file(@linusg) (#386)
• Added command line option for getting all artist's songs (@AlfredoSequeida) (#389)
• Add support for .m3u playlists (@ritiek) (#401)
• Output error details when track download fails from list file (@ManveerBasra) (#406)
• Introduce usage of black (code formatter) (@linusg) (#393)

Changed

• Moved a lot of content from README.md to the repository's GitHub wiki
• Refactored internal use of logging (@arryon) (#358)
• Remove duplicates from track file while preserving order (@ritiek) (#369)
• Windows - 'My Music' folder won't be assumed to be on C drive but looked up in Registry (@SillySam) (#387)
• Don't search song on Spotify if --no-metadata is passed (@ManveerBasra) (#404)
• Refactored Spotify token refresh (@ManveerBasra) (#408)
• Updated dependencies to their newest versions (as of 2018-10-02) (@linusg) (#382)
• Updated setup.py (fix PyPI URL, add Python 3.7 modifier) (@linusg) (#383)
• --list flag accepts only text files using mimetypes (@ManveerBasra) (#414)
• Changed test track to one whose lyrics are found (@ManveerBasra) (#400)

Fixed

• Slugify will not ignore the ' character (single quotation mark) anymore (@jimangel2001) (#357)
• Correctly embed metadata in .m4a (@arryon) (#372)
• Check and replace slashes with dashes to avoid directory creation error (@ManveerBasra) (#402)
• Filter unwanted text from Spotify URLs when extracting information (@ritiek) (#394)

[1.0.0] - 2018-09-09

Added

• Initial complete release, recommended way to install is now from PyPI

1.0.0-beta.1 - 2018-02-02

Added

• Initial release, prepare for 1.0.0

I think this should be it.

we might encourage people to keep the Unreleased section up to date with each PR. (See https://keepachangelog.com/en/1.0.0/)

I also like this idea of making changes to the with the PR itself. We may want to update our CONTRIBUTING.md to mention this.

---

By the way, how about we black format the code once before every release instead of every PR?

Reminding contributors to format their changes would be unnecessary drain on our side IMO when we could just run it once before a release and have the same effect (or unless the PR code is so messed up that it really needs to be black formatted before merge).

In the case of CHANGES.md however, it will certainly help us keep the track of changes more orderly and we won't accidentally miss a change mention in this way if the changelog is updated with every PR. Thoughts?

[linusg]

Good job!

changed @mention to @username instead of [@username](https://github.com/username)

Just want to add a reminder here: when rendered outside of GitHub (locally, PyPI etc.), this won't create links to the GH profiles but just display @username BUT I'm fine with that.

---

Changelog

I'd prefer .m4a over .m4a, like I did with the other file extensions (I've missed this one).

Embed comment metadata in .m4a

You lost a space character here (where the _ is):

[...] appending to track file_(@linusg) (#386)

Edit:

Moved a lot of content from README.md to the repository's GitHub wiki

We may credit @sdhutchins and @ritiek here, I think you two did most of the work there.

---

By the way, how about we black format the code once before every release instead of every PR?

Sounds like a good idea to me!

In the case of CHANGES.md however, it will certainly help us keep the track of changes more orderly and we won't accidentally miss a change mention in this way if the changelog is updated with every PR. Thoughts?

👍

[ritiek]

Just want to add a reminder here: when rendered outside of GitHub (locally, PyPI etc.), this won't create links to the GH profiles

That's an important point! We should probably revert back to manually linking to the GitHub user profile.

I'm also happy with the other proposed changes. Do you want to attempt a PR to update our CHANGES.md?

[ritiek]

We may credit @sdhutchins and @ritiek here, I think you two did most of the work there.

Thank you :)

[linusg]

We should probably revert back to manually linking to the GitHub user profile.
Do you want to attempt a PR to update our CHANGES.md?

Will do.

[ritiek]

Congratulations on v1.1.0!