patrick-5546 / sampleproject Goto Github PK

Explore sites like https://github.com/nedbat/scriv to get inspiration on how to further improve this template.

Ideas

• Create seperate environments for linters and formatters
• Create makefile
• Add more repository badges
  • https://github.com/dwyl/repo-badges
  • https://thomas-cokelaer.info/blog/2014/08/1013/
• Add isort vscode extensions and dependencies
• Additional options in https://github.com/pypa/gh-action-pypi-publish
• https://levelup.gitconnected.com/python-a-toxic-work-environment-tox-poetry-b8200563c474
  https://python-poetry.org/docs/faq/#is-tox-supported

• Stop using custom template once NilsJPWerner/autoDocstring#232 has been resolved

Prerequisites

• #5

Things that need to be done

• Update version in pyproject.toml
• Generate CHANGELOG.md
  • Include in docs using snippets
• Tag commit
• Build and push to pip
• Publish GitHub release
  • Should match CHANGELOG.md

Reworked release steps

Cleanup

• Remove .github/release.yml, the previous release method
• Document release steps in docs
• Add changelog to project.urls in pyproject.toml

Start from templates in https://github.com/UBCSailbot/.github

Use Material for MkDocs to host documentation

To do

• Base it off my previous website: https://github.com/UBCSailbot/docs
• Use mkdocstrings to generate documentation from sources
• Set up versioning: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning
  • Learnings from patrick-5546/notes#32
• markdown vs code extensions
• lint, build, publish docs in workflow
  • Integrate with tox
  • Use default configuration file names
• Move contents of CONTRIBUTING.md to infrastructure page of docs
  • Or use snippet
• Add offline plugin
• Create files in page tree
• Write developer guide
• Comment code

Page tree

• Home
  • License
• User Guide
  • Installation
  • Getting Started
  • Commands
  • Configuration
• Code Reference
  • Coverage Report (see https://mkdocstrings.github.io/coverage/)
• Development
  • Contributing
    • Setup
    • Environments
      • Test
      • Lint
      • ...
  • Adapting this Repository Template
  • VS Code Integration
  • GitHub Actions Integration
  • Create a Release

Description

Trying out the template to see what is missing

Changes

• - in repo and package name, _ in module name
  • Just avoid those
• Add link to documentation on pip homepage
• When renaming, can exclude requirements (run tox -e upgrade after)
• Separate replacing patrick-5546 and sampleproject
• Don't need step 1 of update readme badges anymore
• Make badge -> Make coverage badge
• Can add a new file to existing gist instead of creating new gist
• Don't need to switch to main branch to setup intially
• No need to set the branch to gh-pages
• May want to look through repo settings (not carried over)
• Add additional context section to PR template
• Add required CI
• Update docstring template
• Combine lint and test dependencies
• Remove extension
• Add punctuation to docstrings template
• Should tox -e upgrade in initial setup to rename dependency comments
• Add comment about # noqa
• Move main() to __main__.py
• Remove data file (or comment out line)

Once out of beta, should be able to delete this line

Resources

• https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter