pytemplates

Unser Projekt: Was das Projekt tut

Willkommen bei our_project .

Bitte beachten Sie, dass dies ein Vorlagen -Repository ist. Siehe auch wichtige Hinweise am Ende dieser Datei.

Installationshandbuch

pip install our_project 

Derzeit implementierte Funktionen

our_project derzeit macht Folgendes:

• Enthält die Basisklasse HelloWorld

• HelloWorld hat die print_text -Methode, die den Benutzer mitgeliefertem Text druckt.

• Eine GitHub -Aktion zum Testen von Projektinstallationen und zum Ausführen von Tests.

• Eine GitHub -Aktion zur Veröffentlichung von PYPI (erfordert das Hinzufügen PYPI_USERNAME und PYPI_PASSWORD zu repository secrets.)

Merkmale, die weitere Aufmerksamkeit benötigen

Wir beabsichtigen, in Zukunft am Folgenden zu arbeiten:

• Machen Sie es weniger umständlich, mit sphinx Dokumente zu initieren.

Dokumentgenerierung

Bitte bearbeiten Sie docs/source/index.rst und docs/source/modules.rst nach Bedarf und dann aus.

./scripts/mkdocs.sh 

Das obige wird davon ausgegangen, dass Sie die Wurzel von "Our_Project" sind.

Löschen Sie auch setup.rst , tests.rst , wenn sie existieren.

Andernfalls führen und bearbeiten Sie nach Bedarf.

sphinx-quickstart

Danke schön,

Nelsongon 22/10/2021

---

Wichtige Anmerkungen

Dieses Repository enthält Vorlagen, die einem typischen Workflow für neue python -Projekte folgen.

Ein Wort der Vorsicht

Diese Vorlagen sollen meist Zeit sparen. Moderne IDEs bieten jedoch Projektvorlagen, die ausgereifter und weniger Meinung sind als die Vorlagen hier.

Dieses Repository dient einem zusätzlichen Zweck, den Entwicklern neu in der Programmierung zu ermöglichen, die Projektstruktur anhand von sehr einfachen Beispielen zu untersuchen.

Bei Lizenzen, Tests und Workflows Gitignore wird empfohlen, diese automatisch entweder aus ihrer IDE der Wahl oder für .gitignore -Dateien und -lizenzen über GitHub oder GitLab zu generieren.

Gerne hören Sie von Ihnen bei Fragen und/oder Feedback.

---

HAFTUNGSAUSSCHLUSS :

Dieses Projekt ist sowieso nicht mit einem ähnlich benannten Paket -Pytemplates zusammen, das etwas völlig anderes tut ("Pytemplates ist eine leichte HTML -Vorlage -Engine, die in Python geschrieben wurde, mit Unterstützung für Vorlagenerbanz, Blöcke, Makros, Kontext und Django.").

Ich habe nur von diesem Paket erfahren, wenn ich dieser Datei Abzeichen hinzufügte.