pytemplates

Proyek kami: apa yang dilakukan proyek

Selamat datang di our_project .

Harap dicatat bahwa ini adalah repositori template, klik Gunakan template (jangan garpu kecuali menyarankan peningkatan) untuk digunakan dalam proyek baru dan mengedit file sesuai kebutuhan . Juga, lihat catatan penting di akhir file ini.

Panduan Instalasi

pip install our_project 

Fitur yang sedang diimplementasikan saat ini

our_project saat ini melakukan hal berikut:

• Berisi kelas dasar HelloWorld

• HelloWorld memiliki metode print_text yang mencetak teks yang disediakan pengguna.

• Tindakan GitHub untuk menguji instalasi proyek dan menjalankan tes.

• Tindakan GitHub untuk dirilis pada PYPI (membutuhkan penambahan PYPI_USERNAME dan PYPI_PASSWORD ke Reprets Repository.)

Fitur yang membutuhkan perhatian lebih lanjut

Kami bermaksud untuk mengerjakan yang berikut di masa depan:

• Jadikan tidak terlalu rumit untuk mendapatkan dokumen dengan sphinx .

Pembuatan dokumen

Harap edit docs/source/index.rst dan docs/source/modules.rst sesuai kebutuhan kemudian jalankan:

./scripts/mkdocs.sh 

Di atas mengasumsikan Anda berada di akar "Our_project".

Juga hapus setup.rst , tests.rst , jika ada.

Kalau tidak, jalankan dan edit seperlunya.

sphinx-quickstart

Terima kasih,

Nelsongon 22/10/2021

---

Catatan penting

Repositori ini memiliki templat yang mengikuti alur kerja khas untuk proyek python baru.

Kata Perhatian

Template ini sebagian besar dimaksudkan untuk menghemat waktu. Namun, IDE modern menyediakan templat proyek yang lebih matang dan kurang berpendapat daripada templat di sini.

Repositori ini melayani tujuan tambahan untuk memungkinkan pengembang yang baru dalam pemrograman untuk mempelajari struktur proyek menggunakan contoh yang sangat sederhana.

Untuk lisensi, pengujian, dan alur kerja, Gitignore disarankan agar seseorang menghasilkan ini secara otomatis baik dari IDE pilihan mereka atau untuk file dan lisensi .gitignore , melalui GitHub atau GitLab.

Senang mendengar dari Anda jika ada pertanyaan dan/atau umpan balik.

---

PENAFIAN :

Proyek ini tidak sesuai dengan pytemplates paket yang sama yang melakukan sesuatu yang sama sekali berbeda ("pytemplates adalah mesin template HTML ringan yang ditulis dalam python, dengan dukungan untuk warisan templat, blok, makro, konteks, dan django.").

Saya hanya harus mengetahui paket ini setelah menambahkan lencana ke file ini.