Đây là một dự án mẫu cho thấy một cách rất tốt để cấu trúc các dự án của bạn:https://github.com/kennethreitz/samplemod. Dự án là về việc tạo mô-đun "mẫu". Cấu trúc thư mục trông như sau:
README.rst LICENSE setup.py requirements.txt sample/__init__.py sample/core.py sample/helpers.py docs/conf.py docs/index.rst tests/test_basic.py tests/test_advanced.py
Tệp README.rst: Tệp này dùng để mô tả ngắn gọn về mô-đun, cách thiết lập, cách sử dụng, v.v.
GIẤY PHÉP: Chứa văn bản giấy phép và mọi khiếu nại về bản quyền.
setup.py: Đó là câu trả lời của Python cho trình cài đặt đa nền tảng và tạo tệp. Nếu bạn đã quen với cài đặt dòng lệnh, hãy tạo &&make install chuyển sang python setup.py build &&python setup.py install. Vì vậy, nó được sử dụng để xây dựng dự án của bạn trên máy người dùng.
request.txt: Tệp yêu cầu Pip phải chỉ định các yếu tố phụ thuộc cần thiết để đóng góp vào dự án:thử nghiệm, xây dựng và tạo tài liệu. Nếu dự án của bạn không có phụ thuộc phát triển hoặc bạn thích thiết lập môi trường phát triển qua setup.py, thì tệp này là không cần thiết.
tài liệu /: Thư mục này chứa tài liệu cho dự án của bạn.
kiểm tra /: Tất cả các bài kiểm tra của bạn sẽ nằm trong thư mục này. Ban đầu, bạn sẽ có một tệp thử nghiệm duy nhất. Khi chúng bắt đầu phát triển, bạn có thể cấu trúc các bài kiểm tra của mình giống như thư mục mô-đun của bạn.
mẫu /: Thư mục này chứa mã mô-đun thực của bạn. Nếu mô-đun của bạn chỉ bao gồm một tệp duy nhất, bạn có thể đặt nó trực tiếp vào thư mục gốc của kho lưu trữ của bạn dưới dạng sample.py. Thư viện của bạn không thuộc thư mục con src hoặc python không rõ ràng. Điều này sẽ chứa một tệp __init__.py nếu bạn muốn mô-đun này nằm trong một gói.