Python

License

Use the BSD 3-clause license.

Version

Applications are written for the latest stable Python version. Packages are written for non-end-of-life versions (see the status of Python branches).

Applications are upgraded to, at minimum, the Python version in the latest Ubuntu LTS version (search for the “python3” package within the LTS suite).

Contents

• Directory layout
  • Applications
  • Packages
  • Modules
  • Test files
  • Static files
  • Filename conventions
• Requirements
  • Get started
  • Add a requirement
  • Install requirements
  • Upgrade requirements
  • Linting
• Preferred packages
  • Preferences
  • Criteria
  • License compliance
• Linting
  • Configuration
  • Pre-commit hooks
  • Skipping linting
  • Continuous integration
  • Optional linting
• Testing
  • Write tests
  • Run tests
• Continuous integration
  • Automated tests
  • Dependabot
  • Maintenance
  • Reference
• Documentation
  • Write docstrings
  • Build documentation locally
  • Check docstring style
  • Check broken links
  • Create a ReadTheDocs project
  • Configure the ReadTheDocs project
  • Redirect a ReadTheDocs project
• Configuration
  • Word choice
  • Deployment
• Logging
  • Name
  • Format
  • Methods
  • Configuration
• Django
  • Directory layout
  • Model Template View
  • URLs
  • Models
  • Forms
  • Views
  • Templates
  • Admin
  • Management commands
  • Settings
  • Performance
  • Deployment
  • Development
• File formats
  • JSON
  • CSV
• General style
  • Built-in functions
  • Naming
  • Comments
  • Type hints
  • Exceptions
  • String formatting
  • Long strings
  • Default values
  • Input/Output
  • Functional style
  • Object-oriented style
  • Standard library
  • Scripts
• Internationalization (i18n)
  • Mark strings to translate
  • Configure message extraction
  • Add the Transifex mapping
  • Translate with Transifex
  • Continuous integration
• Accessibility (a11y)
  • Automated tests
  • Continuous integration
• Packages
  • Metadata
  • Documentation
  • Release process
• Performance
  • CPU profiling
  • Memory profiling
  • Reference

Reference: 18F Python Development Guide