especificación del directorio desarrollo de programas de pitón

Un mejor control de la estructura del programa de normalización, hacer la aplicación más fácil de leer.

Proyecto de estructura de directorios "en realidad pertenece a la categoría de" legibilidad y facilidad de mantenimiento, "diseñamos una estructura jerárquica de directorios clara, que es lograr los dos puntos siguientes:

1. Alta legibilidad : no está familiarizado con el código para este proyecto la gente, uno puede entender la estructura de directorios, que se conoce script de inicio, donde el directorio de prueba, en el que el archivo de configuración, y así sucesivamente. Así que muy rápido sobre este proyecto.

2. Alta capacidad de mantenimiento : La definición de una buena reglas de organización, los defensores será capaz de saber con toda claridad que los nuevos archivos y códigos deben ser sometidos a cualquier directorio. La ventaja es que, con el tiempo, aumenta el tamaño de código / de configuración, la estructura del proyecto no serán confundidos, siendo capaz de organizar también.

Por lo tanto, mantener una estructura de directorio de nivel claro es necesario.

Sobre cómo organizar una buena estructura de directorios del proyecto de Python, ya hay cierto consenso ha sido la estructura de directorios.

Asumiendo el nombre del proyecto es foo, la estructura de directorios conveniente más se parece a esto:

Foo / 
| - bin / 
| | - foo 
| 
| - foo / 
| | - Pruebas / 
| | | - __init__.py 
| | | - test_main.py 
| | 
| | - __init__.py 
| | - main.py 
| 
| --conf / 
| | - __init__.py 
| | - settings.py 
| 
| --logs / 
| 
| - docs / 
| | - conf.py 
| | - abc.rst 
| 
| - setup.py 
| - requirements.txt 
| - README

explicación sencilla:

1. bin/: Algunos artículos se almacenan en archivos ejecutables

2. foo/: Guarde todo el código fuente del proyecto.

   (1) todos los módulos de código fuente, los paquetes deben ser colocados en este directorio. No ponga el directorio de nivel superior.

   (2) su sub- tests/código de prueba unidad de almacenamiento;

   Un programa de entrada (3) se nombra preferiblemente main.py.

3. conf/: Algunos elementos almacenados en el archivo de configuración.

4. logs/: Información de registro se almacena en la ejecución del proyecto.

5. docs/: Almacenar algunos documentos.

6. setup.py: La instalación, despliegue, la escritura se envasa.

7. requirements.txt: Paquete de Python almacenar una lista de dependencias de software externos.

8. README: La documentación del proyecto.

README requisitos de escritura:

Cabe señalar que los siguientes asuntos:

1. Las funciones básicas de la localización de software, software.

2. El método de la ejecución de código: entorno de la instalación, las órdenes de marcha.

3. Una descripción breve del uso.

4. estructura de directorio de código, una descripción más detallada se puede señalar los principios básicos del software.

5. las preguntas más frecuentes.

En los primeros días de desarrollo de software, debido a que el proceso de desarrollo no es clara o por encima de cambio puede, no necesariamente a toda la información se complementará desde el principio. Pero al final del proyecto, es la necesidad de escribir un documento de este tipo.