our_projectへようこそ。
これはテンプレートリポジトリであることに注意してください。[改善を提案しない限り、テンプレートを使用しないでください)をクリックして、新しいプロジェクトで使用し、必要に応じてファイルを編集します。また、このファイルの最後に重要なメモを参照してください。
pip install our_project our_project現在、次のことを行います。
基本クラスのHelloWorldが含まれています
HelloWorldには、ユーザーが提供するテキストを印刷するprint_textメソッドがあります。
プロジェクトのインストールをテストしてテストを実行するためのGitHubアクション。
PypiでリリースするGitHubアクション( PYPI_USERNAMEとPYPI_PASSWORDリポジトリシークレットに追加する必要があります。)
将来、以下に取り組むつもりです。
sphinxを使用してドキュメントを開始するのは面倒ではありません。docs/source/index.rstおよびdocs/source/modules.rstを編集してください。
./scripts/mkdocs.sh
上記は、あなたが「our_project」の根本にいると仮定しています。
また、 setup.rst 、 tests.rstが存在する場合は削除します。
それ以外の場合は、必要に応じて実行して編集します。
sphinx-quickstartありがとう、
Nelsongon 22/10/2021
このリポジトリには、新しいpythonプロジェクトの典型的なワークフローに従うテンプレートがあります。
注意の言葉
これらのテンプレートは、主に時間を節約することを目的としています。ただし、Modern Idesは、ここでテンプレートよりも成熟しており、意見が少ないプロジェクトテンプレートを提供します。
このリポジトリは、非常に簡単な例を使用して、プログラミングを初めてプログラミングしてプロジェクト構造を研究できるようにするという追加の目的を果たします。
ライセンス、テスト、ワークフローの場合、Gitignoreの場合、GithubまたはGitlabを介して、選択したIDEまたは.gitignoreファイルおよびライセンスのいずれかから自動的に生成することをお勧めします。
質問やフィードバックがあれば、ご連絡をお待ちしております。
免責事項:
とにかく、このプロジェクトは、まったく異なることを行う同様の名前が付けられたパッケージpytemplatesに関連していません(「pytemplatesは、テンプレート継承、ブロック、マクロ、コンテキスト、およびdjangoをサポートして、Pythonで記述された軽量のHTMLテンプレートエンジンです。」)。
このファイルにバッジを追加すると、このパッケージを知ることができました。