Skip to content

CHEATSHEET.rst

Latest commit

 

History

History
102 lines (64 loc) · 2.95 KB

CHEATSHEET.rst

File metadata and controls

102 lines (64 loc) · 2.95 KB

Finishing setting up your project

Thanks for using cookiecutter-trio! This is your project now; you can customize it however you like. Here's some reminders of things you might want to do to get started:

  • Check this into source control (git init .; git add .; git commit -m "Initial commit")
  • Add a CODE_OF_CONDUCT.md
  • Add a CONTRIBUTING.md
  • Search the source tree for COOKIECUTTER-TRIO-TODO to find other places to fill in.

{%- if cookiecutter._license_info[cookiecutter.license].slug == "other" %}

  • Since you selected an "other" license: remove LICENSE-IS-MISSING and add a LICENSE file, and update setup.py and README.rst to tell people your license choice.

{%- endif %}

  • Enable Read the Docs. (Note: this project contains a .readthedocs.yml file that should be enough to get things working.)

  • Set up continuous integration: Currently, this project is set up to test on Linux, MacOS, and Windows using Github Actions, and to test some additional Python versions on Linux (PyPy and nightly) using Travis.

    If that's what you want, then go to Travis and Github Actions and enable testing for your repo.

    If that's not what you want, then you can trim the list by modifying (or deleting) .travis.yml, .github/workflows/ci.yml, ci.sh.

  • Enable Codecov for your repo.

  • If you want to use static typing (mypy) in your project:

    • Update install_requires in setup.py to include "trio-typing" (assuming you use it).
    • Uncomment the dependency on mypy in test-requirements.txt.
    • Uncomment the mypy invocation in check.sh.
    • Create an empty {{cookiecutter.package_name}}/py.typed file, and add "include {{cookiecutter.package_name}}/py.typed" to MANIFEST.in.

  • File bugs or pull requests on cookiecutter-trio reporting any problems or awkwardness you ran into (no matter how small!)

  • Delete this checklist once it's no longer useful

Tips

To run tests

  • Install requirements: pip install -r test-requirements.txt (possibly in a virtualenv)
  • Actually run the tests: pytest {{cookiecutter.package_name}}

To run black

  • Show what changes black wants to make: black --diff setup.py {{cookiecutter.package_name}}
  • Apply all changes directly to the source tree: black setup.py {{cookiecutter.package_name}}

To make a release

  • Update the version in {{cookiecutter.package_name}}/_version.py
  • Run towncrier to collect your release notes.
  • Review your release notes.
  • Check everything in.
  • Double-check it all works, docs build, etc.
  • Build your sdist and wheel: python -m pep517.build --source --binary --out-dir dist/ .
  • Upload to PyPI: twine upload dist/*
  • Use git tag to tag your version.
  • Don't forget to git push --tags.