Python Directory structure

A basic directory structure consists of the following:

  • A readme file
  • A license file
  • setup.py (a file with exactly this name has a specific purpose, see the next section.)
  • Your code organized into logical folders, which depends entirely on the project. Common sub-folders are:
    • "docs" for your documentation
    • "tests" for your unit tests.

For example, this is what a basic directory structure looks like:

The ".pyproj" is an extra file that Visual Studio 2019 added as part of the Python project. Depending on the editor you are using, you may see other types of files in your project folder.