pytemplates

Nuestro proyecto: lo que hace el proyecto

Bienvenido a our_project .

Tenga en cuenta que este es un repositorio de plantilla, haga clic en Usar plantilla (no bifurque a menos que sugiera una mejora) para usar en un nuevo proyecto y editar archivos según sea necesario . Además, vea las notas importantes al final de este archivo.

Guía de instalación

pip install our_project 

Características implementadas actualmente

our_project actualmente hace lo siguiente:

• Contiene HelloWorld de clase base

• HelloWorld tiene el método print_text que imprime texto suministrado por el usuario.

• Una acción de GitHub para probar la instalación del proyecto y ejecutar pruebas.

• Una acción de GitHub para su lanzamiento en PYPI (requiere agregar PYPI_USERNAME y PYPI_PASSWORD a secretos del repositorio).

Características que necesitan más atención

Tenemos la intención de trabajar en lo siguiente en el futuro:

• Haga que sea menos engorroso a Init Docs con sphinx .

Generación de documentos

Edite docs/source/index.rst y docs/source/modules.rst según sea necesario y luego ejecute:

./scripts/mkdocs.sh 

Lo anterior supone que está en la raíz de "our_project".

También elimine setup.rst , tests.rst , si existen.

De lo contrario, ejecute y edite según sea necesario.

sphinx-quickstart

Gracias,

Nelsongon 22/10/2021

---

Notas importantes

Este repositorio posee plantillas que siguen un flujo de trabajo típico para nuevos proyectos python .

Una palabra de precaución

Estas plantillas están destinadas a ahorrar tiempo. Sin embargo, los IDE modernos proporcionan plantillas de proyecto que son más maduras y menos obstinadas que las plantillas aquí.

Este repositorio tiene un propósito adicional de permitir a los desarrolladores nuevos en la programación estudiar la estructura del proyecto utilizando ejemplos muy simples.

Para licencias, pruebas y flujos de trabajo, Gitignore se recomienda que se genere automáticamente desde su IDE de elección o para archivos y licencias .gitignore , a través de Github o Gitlab.

Feliz de saber de usted en caso de cualquier pregunta y/o comentarios.

---

DESCARGO DE RESPONSABILIDAD :

Este proyecto no está relacionado con un paquete de igualmente llamado PyTemplates que hace algo completamente diferente ("Pytemplates es un motor de plantilla HTML liviano escrito en Python, con soporte para la herencia de plantilla, bloques, macros, contexto y django").

Solo tengo que conocer este paquete al agregar insignias a este archivo.