Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a new test case, fixed some formatting in client.py, and added to user documentation for both sphinx and the README #1053

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased
- Added new minor fixes to make formatting more consistent
- Added more documentation
- Added a new test case to increase code coverage

### Added

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,7 @@ Don’t forget to add the *Spotipy* tag, and any other relevant tags as well, be
If you have suggestions, bugs or other issues specific to this library,
file them [here](https://github.com/plamere/spotipy/issues).
Or just send a pull request.

## Contributing

If you would like to contribute to the project, see more on how to do so in the [CONTRIBUTING.md](https://github.com/spotipy-dev/spotipy/blob/master/CONTRIBUTING.md) file or in the contributing section in our [full](https://spotipy.readthedocs.io/en/2.22.1/#contribute) documentation page.
23 changes: 15 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -322,39 +322,46 @@ Export the needed Environment variables:::
export SPOTIPY_CLIENT_ID=client_id_here
export SPOTIPY_CLIENT_SECRET=client_secret_here
export SPOTIPY_CLIENT_USERNAME=client_username_here # This is actually an id not spotify display name
export SPOTIPY_REDIRECT_URI=http://localhost:8080 # Make url is set in app you created to get your ID and SECRET
export SPOTIPY_REDIRECT_URI=http://localhost:8080 # Make sure url is set in app you created to get your ID and SECRET

Create virtual environment, install dependencies, run tests:::
For more information, see `this <https://spotipy.readthedocs.io/en/2.22.1/#welcome-to-spotipy>`_ section

Create virtual environment, install dependencies, run tests:
$ virtualenv --python=python3.7 env
(env) $ pip install --user -e .
(env) $ python -m unittest discover -v tests

**Lint**

To automatically fix the code style:::
To automatically fix the code style:
pip install autopep8
autopep8 --in-place --aggressive --recursive .

To verify the code style:::
To verify the code style:
pip install flake8
flake8 .

To make sure if the import lists are stored correctly:::
To make sure if the import lists are stored correctly:
pip install isort
isort . -c -v

**Publishing (by maintainer)**
------------------------------

- Bump version in setup.py
- Bump and date changelog
- Add to changelog:
::
## Unreleased

// Add your changes here and then delete this line
### Added
- Replace with changes

### Fixed

### Removed

- Commit changes
- Package to pypi:
::
python setup.py sdist bdist_wheel
python3 setup.py sdist bdist_wheel
twine check dist/*
Expand Down
Loading
Loading