Workshop for PyCon APAC 2018 in Singapore: Making a modern Python package
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.gitignore
LICENSE
README.md
step1-structure.md
step2-writing-setup.md
step3-testing.md
step4-docs.md
step5-pypi-deployment.md
step6-badges.md
step7-towncrier.md
step8-github-extras.md

README.md

Making a modern Python package

Tasks and topics

  • Step 1: Setting up a GitHub repository with a recommended directory structure
  • Step 2: Writing the first version of setup.py and testing it using virtualenv
  • Step 3: Adding test cases using pytest and setting up Travis CI for automated tests
  • Step 4: Writing a good-looking documentation using Sphinx and readthedocs.io
  • Step 5: Deploying to PyPI with twine
  • Step 6: Adding shiny badges to the GitHub README
  • Step 7: Using towncrier to automatically keep changelog up-to-date
  • Step 8: Provide templates for contributors

Please come and ask questions related to above topics!
As long as our time allows, I could help you to resolve problems in the packaging and CI setups of your projects.

Materials

Real-world examples with simple and complicated deployments