How to Structure a Non-Trivial Python Desktop Application Project: A Guide to Folder Hierarchy

How to Structure a Non-Trivial Python Desktop Application Project

When developing a complex Python application, organizing your project effectively is crucial for maintainability, testing, and packaging. Here's a comprehensive guide to structure your project's folder hierarchy:

Source Code

• Place source code under a designated folder, e.g., "/src" or "/code".
• Organize modules and classes within subdirectories based on logical divisions.

Application Startup Scripts

• Store executable scripts that launch the application in a separate folder, e.g., "/bin" or "/scripts".
• Name scripts descriptively to indicate their functions.

IDE Project Cruft

• IDE-specific configuration files, such as ".vscode" or ".idea" folders, should be kept separate.
• Consider excluding these files from version control.

Unit and Acceptance Tests

• Dedicate a folder for unit and acceptance tests, e.g., "/tests".
• Organize test files based on the functionality they test.

Non-Python Data

• Store non-Python configuration files, such as JSON or YAML, in a separate folder, e.g., "/config".
• Ensure that these files are properly versioned.

Non-Python Sources

• Place C source code for pyd/so extension modules in a dedicated folder, e.g., "/lib/cpp".
• Include appropriate build instructions and scripts for compiling and installing these modules.

Top-Level Directory

• The top-level directory should contain important files such as:

  • README file with project description and installation instructions
  • Configuration files for setting project-wide parameters
  • Version control files (e.g., ".git")
• This directory can also serve as a high-level architectural breakdown of the application.

Additional Considerations

• Use a version control system such as Git to track project changes.
• Consider using a Python packaging tool like setuptools or wheel for installing and distributing your application.
• Document your project structure and organization for easy onboarding and collaboration.

The above is the detailed content of How to Structure a Non-Trivial Python Desktop Application Project: A Guide to Folder Hierarchy. For more information, please follow other related articles on the PHP Chinese website!