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
  • Continuous integration
  • Additional linting
• Testing
  • Write tests
  • Run tests
• Continuous integration
  • Automated tests
  • Dependabot
  • Maintenance
  • Reference
• Documentation
  • Write docstrings
  • Build documentation locally
  • Check broken links
  • ReadTheDocs
• 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
  • Naming
  • Comments
  • Whitespace
  • Type annotations
  • Exceptions
  • Warnings
  • Formatted strings
  • Long strings
  • Data structures
  • Input/Output
  • Functional style
  • Object-oriented style
  • Simple statements
  • Standard library
  • Scripts
• Internationalization (i18n)
  • Install dependencies
  • Initialize tool configuration
  • Mark strings to translate
  • Configure message extraction
  • Extract strings to translate
  • Update tool configuration
  • Translate with a tool
  • Compile the PO files to MO files
  • Continuous integration
• Accessibility (a11y)
  • Automated tests
  • Continuous integration
• Performance
  • Profiling
  • Optimizations
  • Reference
• Packages
  • Metadata
  • Documentation
  • Publish releases

Reference: 18F Python Development Guide