Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 1.68 KB
Raw

Contributing

If you would like to contribute to spotipy follow these steps:

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

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:

pip install autopep8
autopep8 --in-place --aggressive --recursive .

To verify the code style:

pip install flake8
flake8 .

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

  • Commit changes

  • Package to pypi:

    python setup.py sdist bdist_wheel
python3 setup.py sdist bdist_wheel
twine check dist/*
twine upload --repository-url https://upload.pypi.org/legacy/ --skip-existing dist/*.(whl|gz|zip)~dist/*linux*.whl

  • Create github release https://github.com/plamere/spotipy/releases with the changelog content for the version and a short name that describes the main addition

  • Verify doc uses latest https://readthedocs.org/projects/spotipy/

Changelog

Don't forget to add a short description of your change in the CHANGELOG