template package cli

Ringkasan

Ini adalah templat paket yang kami gunakan secara internal saat membuat alat berbasis Python CLI baru. Ini memiliki semua fungsi dasar dan alur kerja yang diperlukan untuk membuat, membangun, dan menerbitkan paket baru ke PYPI.

Paket ini menyediakan utilitas baris perintah untuk memproses dan menangani berbagai tugas menggunakan serangkaian argumen dan konfigurasi yang telah ditentukan. Proyek ini bertujuan untuk berfungsi sebagai garis dasar untuk mengembangkan aplikasi baris perintah yang serupa.

Ini mencakup fitur -fitur seperti parsing argumen, manajemen konfigurasi, dan struktur modular untuk memfasilitasi pengembangan kode yang dapat diskalakan dan dipelihara.

Kami juga menyediakan 2 templat lain yang kami gunakan.

• Proyek Template Python
• Paket template yang dapat diimpor

Fitur

• Arsitektur Modular : Atur kode Anda ke dalam modul untuk pemeliharaan yang lebih baik.
• Argumen Parsing : Mudah menangani argumen baris perintah menggunakan argparse .
• Manajemen Konfigurasi : Hasilkan objek konfigurasi dari argumen baris perintah.
• Pengecualian Kustom : Menerapkan pengecualian khusus untuk penanganan kesalahan tertentu.

Instalasi

Untuk menginstal paket CLI, klon repositori dan navigasikan ke direktori proyek:

git clone https://github.com/DevelopersToolbox/template-package-cli.git
cd template-package-cli

Disarankan untuk menggunakan lingkungan virtual untuk mengelola dependensi. Anda dapat membuat dan mengaktifkan lingkungan virtual menggunakan perintah berikut:

python -m venv venv
source venv/bin/activate  # On Windows, use `venvScriptsactivate`

Instal dependensi yang diperlukan:

pip install -r requirements.txt

Penggunaan

Untuk menjalankan paket CLI, jalankan fungsi main dari skrip utama:

python -m wolfsoftware.template_package_cli.main --required < value >

Argumen baris perintah

Aplikasi mendukung beberapa argumen baris perintah:

• -h, --help : Tampilkan pesan bantuan dan keluar.
• -d, --debug : Aktifkan mode debug untuk output verbose.
• -v, --verbose : Aktifkan output verbose untuk menunjukkan hasil pemindaian saat mereka masuk.
• -V, --version : Tampilkan nomor versi program dan keluar.
• -i, --optional-integer : Argumen integer opsional (default: 2).
• -s, --optional-string : Argumen string opsional (default: "me").
• -r, --required : argumen string yang diperlukan.

Contoh Penggunaan:

python -m wolfsoftware.template_package_cli.main -r " required_value " -i 10 -s " optional_string " 

Struktur proyek

Proyek ini diselenggarakan sebagai berikut:

template-package-cli/
├── wolfsoftware/
│   └── template_package_cli/
│       ├── __init__.py
│       ├── cli.py
│       ├── config.py
│       ├── exceptions.py
│       ├── globals.py
│       └── main.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_cli : Berisi modul inti aplikasi.
  • cli.py : Menangani argumen baris perintah dan aliran program utama.
  • config.py : Menangani pembuatan konfigurasi dari argumen baris perintah.
  • exceptions.py : Menangani pengecualian khusus.
  • globals.py : Menentukan konstanta global yang digunakan di seluruh aplikasi.
  • main.py : Script utama yang mengatur argumen parsing dan eksekusi program.
• requirements.txt : Daftar dependensi yang diperlukan untuk proyek.
• README.md : File yang sedang Anda baca.