Home - goerz/cookiecutter-pypackage GitHub Wiki

This wiki collects knowledge around creating and maintaining open source Python packages, as well as tooling around Python development and documentation in general.

Vim

• Notable Vim Plugins
• Vim Configuration Recommendations

Git and Github

• Useful Git Aliases
• Branching Workflows
• Committing Partial Changes

Virtual Environments

• Using pyenv
• Using Anaconda/Miniconda
• Virtual environments

Testing

• Using pytest
• Continuous Integration with TravisCI and AppVeyor
• How to install texlive on Travis
• Testing against Multiple Versions of Python with tox
• Debugging Recommendations
• Measuring Test Coverage

Documentation

• Writing Good Documentation
• RestructuredText Howtos
• Writing Docstrings
• Sphinx Setup
• API Generation
• Intersphinx
• Documentation Hosting
• Showing multiple versions in Doctr

Code Style

• Black Code Style
• Sorting Imports

Package Deployment

• Python Project Creation with cookiecutter
• Package Versioning
• Releasing to the Python Package Index (PyPI)

Jupyter Notebooks

• Jupyter Notebooks and JupyterLab
• Integrating Jupyter Notebooks in a Sphinx Documentation
• Editing Notebooks in a Text Editor
• Version Control and Diffing Notebooks