project ├── README.md ├── example │ ├── __init__.py │ ├── package_1 │ │ ├── __init__.py │ │ ├── awesome_module.py │ │ ├── ...

Some projects might include more code, especially if you are using Cython or creating C-extensions to Python. However, if you are not, then this style will probably suffice. The reason we keep the setup.py minimal is that we want to keep as much of the setup configuration as possible inside the setup.cfg file.

Sample project structure for a python package, contains all the necessary files to publish a PyPI package.

The project contains a fact package that provides a simple implementation of the factorial algorithm (fact.lib) and a command line interface (fact.cli). This package uses uv to manage dependencies and isolated Python virtual environments.

Simple example of a good project structure with pytest and sphinx implemented - ferdinandvanwyk/python_project_example

Show how to structure a Python project. Inspired by https://github.com/kennethreitz/samplemod.

You should examine the files here, decide which are right for you, and adapt them to your needs. This directory is where you put your code. It should have one subdirectory named for your project, and all of your work goes into that subdirectory.

This simple project is an example repo for Python projects.

This is a simple example of the overall organization of a Python project based on best practices.

Clean example project showing the recommended folder structure and .claude configuration for Claude Code (Anthropic's AI coding assistant). Built with FastAPI + Python.

This repository provides a minimal, yet opinionated baseline for Python [1] software projects.

The metadata for a Python project is defined in the pyproject.toml file, an example of which is included in this project. You should edit this file accordingly to adapt this sample project to your needs.

March 21, 2020 - Some examples of .gitignore files can be found in this github repository. I usually start with a small number of files and build gradually. My basic .gitignore might resemble this: # Pycache and compiled python files. __pycache__/ *py[cod] # Jupyter notebook checkpoints .ipynb_checkpoints #Egg info files produced by pip installation *egg-info · A readme is a documentation file often written in markdown. It contains useful information so that others can understand what your project is about.

dev_template is a user-friendly tool for setting up new Python projects. It provides a consistent structure, easy to use features, and cross-platform compatibility. This tool is for those of us that are lazy, simplifying the installation of packages, creation of directories, config files, and virtual environments.

Example of how to structure a python project, run tests, give documentation and use Travis CI - MatthewDaws/ExamplePythonTravis

README.rst samplesite/manage.py samplesite/samplesite/settings.py samplesite/samplesite/wsgi.py samplesite/samplesite/sampleapp/models.py · Don't do this. Repetitive paths are confusing for both your tools and your developers. Unnecessary nesting doesn't help anybody (unless they're nostalgic for monolithic SVN repos). ... Note the ".". ... Thanks to the way imports and modules are handled in Python, it is relatively easy to structure a Python project.

This repository is part of my post: Python Project Structure, where I explain my favorite way to organize and structure Python projects.

Sample python project structure, base architecture and tools.

January 18, 2023 - Overall, taking the time to structure a Python project when starting can save a lot of time and heartache in the long run, by making the project easier to understand, maintain, and expand. The repository containing this example project is available on GitHub here: example_python_project.

The project template provides you with following features: All configuration can be done in setup.cfg like changing the description, URL, classifiers, installation requirements and so on as defined by setuptools. That means in most cases it is not necessary to tamper with setup.py. In order to build a source or wheel distribution, just run tox -e build (if you don't use tox, you can also install build and run python -m build).