pytemplates

Notre projet: ce que fait le projet

Bienvenue dans our_project .

Veuillez noter qu'il s'agit d'un référentiel de modèles, cliquez sur le modèle d'utilisation (ne fourre pas sauf suggérer une amélioration) à utiliser dans un nouveau projet et modifier les fichiers au besoin . Voir également les notes importantes à la fin de ce fichier.

Guide d'installation

pip install our_project 

Fonctionnalités actuellement implémentées

our_project fait actuellement ce qui suit:

• Contient la classe de base HelloWorld

• HelloWorld a la méthode print_text qui imprime le texte fourni par l'utilisateur.

• Une action GitHub pour tester l'installation du projet et exécuter des tests.

• Une action GitHub à publier sur PYPI (nécessite l'ajout PYPI_USERNAME et PYPI_PASSWORD aux secrets de référentiel.)

Caractéristiques qui nécessitent une nouvelle attention

Nous avons l'intention de travailler sur ce qui suit à l'avenir:

• Rendez-le moins lourd pour les documents init avec sphinx .

Génération de documents

Veuillez modifier docs/source/index.rst et docs/source/modules.rst Selon requis, puis exécutez:

./scripts/mkdocs.sh 

Ce qui précède suppose que vous êtes à la racine de "our_project".

Supprimez également setup.rst , tests.rst , s'ils existent.

Sinon, exécutez et modifiez si nécessaire.

sphinx-quickstart

Merci,

Nelsongon 22/10/2021

---

Notes importantes

Ce référentiel contient des modèles qui suivent un flux de travail typique pour de nouveaux projets python .

Un mot de prudence

Ces modèles sont principalement destinés à gagner du temps. Cependant, les IDE modernes fournissent des modèles de projet plus matures et moins opinionnés que les modèles ici.

Ce référentiel a un objectif supplémentaire de permettre aux développeurs nouveaux à la programmation pour étudier la structure du projet en utilisant des exemples très simples.

Pour les licences, les tests et les workflows, Gitignore, il est recommandé de les gérer automatiquement à partir de leur IDE de choix, soit pour les fichiers et licences .gitignore , via GitHub ou GitLab.

Heureux de vous entendre en cas de questions et / ou de commentaires.

---

CLAUSE DE NON-RESPONSABILITÉ :

Ce projet n'est pas de toute façon lié à un package de pytemplates de manière similaire qui fait quelque chose de complètement différent ("PyTemplates est un moteur de modèle HTML léger écrit en python, avec le support pour l'héritage du modèle, les blocs, les macros, le contexte et le django.").

Je n'ai à apprendre ce package que lors de l'ajout de badges à ce fichier.