Skip to content

docs: fix CHEATSHEET.rst broken commands (test-requirements.txt, setup.py) #61

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.

Sign up for GitHub

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

Open
VedantBhayani wants to merge 1 commit into
base: master
Choose a base branch
from
+5 −7
Open

docs: fix CHEATSHEET.rst broken commands (test-requirements.txt, setup.py) #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 5 additions & 7 deletions CHEATSHEET.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Tips
To run tests
------------

* Install requirements: ``pip install -r test-requirements.txt``
* Install requirements: ``pip install -e ".[test]"``
(possibly in a virtualenv)

* Actually run the tests: ``pytest sniffio``
Expand All @@ -13,11 +13,9 @@ To run tests
To run yapf
-----------

* Show what changes yapf wants to make: ``yapf -rpd setup.py
sniffio``
* Show what changes yapf wants to make: ``yapf -rpd sniffio``

* Apply all changes directly to the source tree: ``yapf -rpi setup.py
sniffio``
* Apply all changes directly to the source tree: ``yapf -rpi sniffio``


To make a release
Expand All @@ -33,10 +31,10 @@ To make a release

* Double-check it all works, docs build, etc.

* Build your sdist and wheel: ``python setup.py sdist bdist_wheel``
* Build your sdist and wheel: ``python -m build``

* Upload to PyPI: ``twine upload dist/*``

* Use ``git tag`` to tag your version.

* Don't forget to ``git push --tags``.
* Don't forget to ``git push --tags``.
Loading