Skip to content

Commit

Permalink
Added a new test case, fixed some formatting in client.py, and added …
Browse files Browse the repository at this point in the history
…to user documentation for both sphinx and the README
  • Loading branch information
hudkinsnoah committed Dec 9, 2023
1 parent 1416d47 commit 7b8c632
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 203 deletions.
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

0 comments on commit 7b8c632

Please sign in to comment.