Maintaining a Python Project When It’s Not Your Job

Speaker

Hynek Schlawack

Material

• video
• slide
• article (highly recommend)

Note

Act 1: Development

• .github/CONTRIBUTING.rst
  • Example - attrs/.github/CONTRIBUTING.rst
  • Encouragement → Everyone can contribute.
  • Workflow outline
  • Code, test, docs and changelog standards
  • Local development environment setup
• .github/CODE_OF_CONDUCT.rst
  • Expectation in behavior
  • GitHub - Adding a code of conduct to your project
• Run test through tox: test on different environment
  • make sure that the user runs exactly the same test commands as the CI
• Having a high test coverage
• Checkers
  • flake8
  • mypy
  • check-manifest
  • twine: check pypi long description
    • Example setup
• Autoformatters
  • black
  • isort
    • Example setup
• pre-commit
  • Example setup
• Documentation

  • Sphinx

    • slice and dice your README in your Sphinx docs to avoid information duplication

    rst .. include:: ../README.rst :start-after: string-1 :end-before: string-2
    * Read the Docs

Act 2: Pull Request

• .github/PULL_REQUEST_TEMPLATE.md
  • checklist
  • Example
• Continuous Integration
• Community
  • Stack Overflow
    • async community
    • searchable
• Maintainer
  • Say thank you to your contributors

Act 3: Release

• Use ISO 8601 (e.g., 1986-03-19) for datetime
• test.pypi
• How to maintain release information?
  • attrs example
    • setup.py
    • init.py

Share on: Twitter ❄ Facebook ❄ Email

---