python project structure github

Python git project-structure convention? [closed]

stackoverflow.com › questions › 69839745 › python-git-project-structure-convention

This is likely dependent on what you are building. The article I linked in my comment breaks out different layouts like so:

CLI Layouts:

One-Off Script
Installable Single Package
Application with Internal Packages

Web App Layouts:

Django
Flask

While link only answers are discouraged here, I think its counter productive to rehash the whole article but the "Installable Single Package" layout has worked for me and looks like this (borrowed from the same article):

helloworld/
│
├── helloworld/
│   ├── __init__.py
│   ├── helloworld.py
│   └── helpers.py
│
├── tests/
│   ├── helloworld_tests.py
│   └── helpers_tests.py
│
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

NOTE: If you have a data directory, I would put it at the same level as tests

Answer from General4077 on Stack Overflow

GitHub

github.com › nedbat › pkgsample

GitHub - nedbat/pkgsample: A simple example of how to structure a Python project · GitHub

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.

GitHub

github.com › csymvoul › python-structure-template

GitHub - csymvoul/python-structure-template: A Python project to use as a template when developing a Python application · GitHub

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

Discussions

Python git project-structure convention? - Stack Overflow

Is there a convention(or even a PEP) on how to structure a python project for example on GitHub? More specifically python-specific files(I know about the README.md, licence, .gitignore-files). I've More on stackoverflow.com

stackoverflow.com

Where can I learn how to structure a Python project?

I use this sample project on GitHub as a template for my Python projects. The project itself is still actively maintained.

Top answer

1 of 1

This is likely dependent on what you are building. The article I linked in my comment breaks out different layouts like so:

CLI Layouts:

One-Off Script
Installable Single Package
Application with Internal Packages

Web App Layouts:

Django
Flask

helloworld/
│
├── helloworld/
│   ├── __init__.py
│   ├── helloworld.py
│   └── helpers.py
│
├── tests/
│   ├── helloworld_tests.py
│   └── helpers_tests.py
│
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

NOTE: If you have a data directory, I would put it at the same level as tests

GitHub

github.com › johnthagen › python-blueprint

GitHub - johnthagen/python-blueprint: 🗺️ Example Python project using best practices 🐍 https://github.com/johnthagen/python-blueprint

Traditionally, Python projects place the source for their packages in the root of the project structure, like:

Starred by 736 users

Forked by 104 users

Languages: Python 56.6% | Dockerfile 43.4%

GitHub

github.com › kengz › python-structure

GitHub - kengz/python-structure: Sample project structure for a python package.

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

Starred by 17 users

Forked by 4 users

Languages: Python 100.0% | Python 100.0%

GitHub

github.com › charlstown › Python-Project-Structure

GitHub - charlstown/Python-Project-Structure: A clean and nice way to structure Python projects · GitHub

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

Author: charlstown

Find elsewhere

Google Bing Mojeek

GitHub

gist.github.com › ericmjl › 27e50331f24db3e8f957d1fe7bbbe510

How to organize your Python data science project · GitHub

I have a lesson learned from multiple months of working with other people that led me to this somewhat complicated, but hopefully ultimately useful directory structure. Under this folder called projectname/, we put in a lightweight Python package called projectname that has all things that are refactored out of notebooks to keep them clean.

GitHub

github.com › bast › somepackage

GitHub - bast/somepackage: Show how to structure a Python project. · GitHub

Show how to structure a Python project. Contribute to bast/somepackage development by creating an account on GitHub.

Author: bast

GitHub

github.com › topics › python-project-template

python-project-template · GitHub Topics · GitHub

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 ...

GitHub

github.com › pyscaffold › pyscaffold

GitHub - pyscaffold/pyscaffold: 🛠 Python project template generator with batteries included

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).

Author: pyscaffold

GitHub

gist.github.com › dl6nm › 858504f58b54f9763cd412e93e6a9a44

Python Project Code Structure, App with internal packages, · GitHub

I’ve adapted this from Jean-Paul Calderone’s classic structure post, and his prescriptions for the use of a bin/ directory are still important. The most important point to remember is that your executable shouldn’t have a lot of code, just an import and a call to a main function in your runner script. If you are using pure Python ...

GitHub

github.com › realpython › python-guide › blob › master › docs › writing › structure.rst

python-guide/docs/writing/structure.rst at master · realpython/python-guide

Thanks to the way imports and modules are handled in Python, it is relatively easy to structure a Python project. Easy, here, means that you do not have many constraints and that the module importing model is easy to grasp.

Author: realpython

GitHub

github.com › rpatterson › project-structure

GitHub - rpatterson/project-structure: Python project structure foundation or template

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

Author: rpatterson

GitHub

github.com › topics › project-structure

project-structure · GitHub Topics · GitHub

All 287 Python 60 TypeScript 44 Go 28 JavaScript 22 Jupyter Notebook 21 Shell 10 HTML 8 C# 7 Java 6 Makefile 5 ... PyTorch Lightning + Hydra. A very user-friendly template for ML experimentation. ⚡🔥⚡ · config template deep-learning best-practices pytorch hydra reproducibility project-structure ...

GitHub

github.com › ferdinandvanwyk › python_project_example

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

Simple example of a good project structure with pytest and sphinx implemented · Good pytest practises: http://pytest.org/latest/goodpractises.html · General Python testing information: http://pythontesting.net/start-here/

Author: ferdinandvanwyk

GitHub

github.com › Qovaxx › pyproject-structure-example

GitHub - Qovaxx/pyproject-structure-example: A personal attempt to systematize information on the structure of the Python project

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

Starred by 2 users

Forked by 3 users

reddit.com › r/learnpython › where can i learn how to structure a python project?

r/learnpython on Reddit: Where can I learn how to structure a Python project?

June 9, 2020 -

As of now every project on my github is just 1 or 2 Python files. I’ve looked at many different projects on github and the majority of them have many different folders and files and I have no clue what their purpose is. Where can I read about properly structuring a Python project?