Software especificación directorio de desarrollo
Con el fin de mejorar la legibilidad y mantenibilidad del programa, debemos ser estructura de directorios de software bien diseñado, la codificación estilo tan importante como esto y normas. especificación del directorio hay software fuerte y rápido estándar, siempre y cuando se puede leer claramente, asumiendo su software llamado foo, recomiendo la siguiente estructura de directorios
Foo/
|-- core/ | |-- core.py | |-- api/ | |-- api.py | |-- db/ | |-- db_handle.py | |-- lib/ | |-- common.py | |-- conf/ | |-- settings.py | |-- run.py |-- setup.py |-- requirements.txt |-- READMEExplicar brevemente:
• Núcleo /: almacenar la lógica de negocio de código relevante
• API /: las interfaces de almacenamiento de archivos, la interfaz se utiliza principalmente para proporcionar datos para el funcionamiento de la lógica de negocio.
• db /: archivos de bases de datos relacionadas con las tiendas operaciones, principalmente para interactuar con bases de datos
• lib /: procedimientos almacenados utilizan comúnmente en los módulos personalizados
• / conf: almacenar archivos de configuración
• run.py: archivos de programa de arranque, a menudo se encuentra en el directorio raíz del proyecto, ya en tiempo de ejecución por defecto se ejecutará la carpeta de archivos donde sys.path como el primer camino, eliminando así el medio ambiente de procesamiento variable de paso
• setup.py: instalación, despliegue, la escritura de empaquetado.
• requirements.txt: Pitón almacén de paquetes una lista de dependencias de software externos.
• README: la documentación del proyecto.
Además, hay una serie de programas se dan más y más contenido, tales como documentos license.txt, changelog.txt, principalmente se utiliza en las necesidades del proyecto de código abierto, el aspecto lector de sí mismo.
Sobre el README, y esto debe ser cada proyecto debe tener un archivo, el propósito es ser capaz de información breve de la descripción del proyecto, lo que permite a los lectores a entender rápidamente el proyecto. Cabe señalar que los siguientes asuntos:
1、软件定位，软件的基本功能；
2、运行代码的方法: 安装环境、启动命令等； 3、简要的使用说明； 4、代码目录结构说明，更详细点可以说明软件的基本原理； 5、常见问题说明。Sobre setup.py y requirements.txt:
En general, utilice setup.py para gestionar el código de paquete, la instalación y los problemas de implementación. El estándar de la industria está escrito en Python setuptools herramientas de empaquetado populares para manejar estas cosas, este método es ampliamente utilizado en proyectos de código abierto. Pero aquí está la idea central de no utilizar herramientas estandarizadas para resolver estos problemas, pero dijo que un proyecto debe tener una herramienta de implementación para instalar, se puede instalar rápida y fácilmente en una máquina nueva en el medio ambiente, se desplegará y ejecutar el código arriba.
existe el archivo Requirements.txt para la comodidad de los desarrolladores para mantener las dependencias de software. Tenemos que confiar en la información en el proceso de desarrollo de base de datos añadida al archivo, para evitar la falta de paquetes cuando setup.py instalar las dependencias, sino también conveniente para los usuarios clara referencia al proyecto que Python paquete.
El formato de archivo se describe en cada fila contiene un paquete dependiente, por lo general frasco de> = 0,10 este formato, el requisito es el formato PIP se puede identificar, por lo que simplemente pip instalar requirements.txt -r para todos Python dependencias se instalan, con referencia al formato específico HTTPS: // pip.readthedocs.io/en/1 0.1 / requirements.html