Instalasi

🚀Instal Custy

Python 3.14+

Pilih metode instalasi native yang didukung, siapkan persyaratannya, dan verifikasi CLI Custy.

Commandpython -m pip install --index-url $PRIVATE_INDEX_URL custy==2.1.2

📦Category

Memulai

🚀Quick Command

python -m pip install [OPTIONS] SOURCE

---

GitLab PyPI privatsource checkoutartefak rilispenyiapan developer

---

📌

Python Native

3.14 atau lebih baru

🌿

Tool Sistem Utama

Git

📁

Isolasi yang Disarankan

Virtual environment

📦

Registry Privat

GitLab PyPI

🐳

Alternatif Container

Build Docker lokal

Ringkasan

Custy dapat diinstal dari registry GitLab PyPI privat milik proyek, source checkout, artefak Python yang dilampirkan pada rilis, atau langsung dari repositori Git. Kontributor sebaiknya menggunakan instalasi editable dengan grup dependensi development. Docker merupakan alternatif terpisah jika Anda tidak ingin menginstal Python atau Git langsung di host.

ℹ️Registry privat, bukan PyPI publik

pip install custy tanpa konfigurasi index tidak akan menemukan proyek ini di PyPI publik. Pengguna yang memiliki akses dapat memilih index GitLab privat; source checkout, artefak rilis, dan revisi Git yang sudah ditinjau tetap didukung sebagai alternatif.

---

Persyaratan

Tool host yang diperlukan bergantung pada apakah Custy dijalankan secara native atau di dalam Docker.

📌Requirements

Python 3.14+

Required

Diperlukan untuk instalasi native. Ini adalah versi minimum yang dinyatakan oleh metadata package saat ini.

pip

Required

Diperlukan untuk instalasi native. Jalankan melalui interpreter Python yang dipilih.

Git

Required

Diperlukan pada host native untuk operasi repositori, versi, changelog, commit, tag, push, dan pipeline Custy.

Virtual Environment

Recommended

Pisahkan Custy dan dependensinya dari Python sistem serta proyek lain.

Docker

Optional

Gunakan cara container sebagai pengganti instalasi Python, pip, atau Git di host.

Make

Optional

Gunakan target Make repositori sebagai helper development dan container; Make tidak diperlukan oleh CLI Custy itu sendiri.

---

Tool untuk Fitur Tertentu

✨Instal Hanya Saat Diperlukan

🌿Commitizen

Instal custy[commitizen] ketika menggunakan Commitizen versioning atau commit-message validation. Tool ini tetap optional untuk normal Custy workflows dan disertakan dalam production Docker image.

✅Pre-Commit Hooks

Instal custy[hooks] ketika local Custy harus menjalankan pre-commit-managed hooks secara langsung. Project tanpa pre-commit tidak memerlukan extra ini. Production image sudah menyertakannya.

📄Editor Interaktif

Instal setidaknya satu configured editor untuk meninjau commit, tag, atau release message. Windows menggunakan VS Code lalu Notepad secara default; Docker menyertakan Micro, Nano, Vim, dan Vi.

🛡️Kredensial Remote

Konfigurasikan SSH atau kredensial Git yang didukung di luar Custy sebelum operasi push berkomunikasi dengan remote.

🐳Docker Compose

Instal plugin Compose hanya ketika menggunakan service development atau production dari repositori.

---

Pilih Metode Instalasi

✨Pilihan Instalasi Native

📦GitLab PyPI Privat

Direkomendasikan bagi pengguna berizin yang menginginkan package immutable dan telah ditinjau tanpa memelihara source checkout.

📁Source Checkout

Direkomendasikan jika Anda ingin memeriksa source secara langsung dan menginstal salinan runtime normal.

📦Artefak Rilis

Instal wheel atau source distribution yang dilampirkan pada rilis yang sudah ditinjau, jika rilis tersebut menyediakannya.

🌿Revisi Git

Instal langsung dari tag atau commit yang sudah ditinjau tanpa menyimpan checkout terpisah.

🚀Penyiapan Editable untuk Kontributor

Instal source tree dalam mode editable beserta tool testing, linting, formatting, packaging, dan Git hook.

---

Metode 1: Instal dari GitLab PyPI Privat

Minta ID proyek GitLab dan deploy token yang hanya memiliki izin read_package_registry kepada maintainer proyek. Kemudian instal satu versi package yang tepat di environment terisolasi.

Instal dari registry proyek privat

bash

python -m venv venv

# Aktifkan environment, lalu instal satu versi yang sudah ditinjau.

python -m pip install --index-url "https://<deploy-user>:<deploy-token>@gitlab.com/api/v4/projects/<project-id>/packages/pypi/simple" "custy==2.1.2"

custy --version

Tag rilis Git tetap menggunakan SemVer, sedangkan metadata package menggunakan PEP 440 kanonis. Contohnya, tag v2.1.0-rc.1 diinstal sebagai custy==2.1.0rc1.

⚠️Simpan kredensial registry di luar repositori

Jangan commit deploy token, URL index yang memuat kredensial, atau konfigurasi pip yang berisi rahasia. Hindari --extra-index-url untuk package privat karena index yang bersaing dapat menimbulkan risiko dependency confusion. Untuk resolusi dependensi yang benar-benar privat, maintainer proyek juga perlu meninjau pengaturan package forwarding GitLab.

---

Metode 2: Instal dari Source Checkout

Clone repositori, buat virtual environment, lalu instal package runtime. Ini adalah cara native yang direkomendasikan jika Anda belum memilih artefak rilis yang sudah ditinjau.

Clone dan buat environment

bash

git clone https://github.com/devalltect00/Custy.git
cd Custy
python -m venv venv

Aktifkan environment sesuai shell yang Anda gunakan.

Windows PowerShell

powershell

venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install .

Linux atau macOS

bash

source venv/bin/activate
python -m pip install --upgrade pip
python -m pip install .

---

Metode 3: Instal Artefak Rilis

Alur rilis Custy dikonfigurasi untuk melampirkan Python wheel dan source distribution. Buka halaman Custy Releases, pilih rilis yang sudah ditinjau, lalu pastikan rilis tersebut benar-benar berisi artefak yang dimaksud sebelum mengunduhnya.

Instal wheel yang sudah diunduh

bash

python -m pip install ./custy-<version>-py3-none-any.whl

Instal source distribution yang sudah diunduh

bash

python -m pip install ./custy-<version>.tar.gz

⚠️Jangan mengunci dokumentasi ke satu rilis lama

Ketersediaan artefak dan nomor versi berubah seiring waktu. Gunakan halaman Releases umum, pilih versi yang dituju secara sengaja, dan verifikasi nama asset yang ditampilkan oleh rilis tersebut.

---

Metode 4: Instal Langsung dari Git

Jika Anda tidak memerlukan checkout lokal, pip dapat menginstal tag atau commit Git yang sudah ditinjau ke environment aktif.

Instal revisi yang sudah ditinjau

bash

# Ganti <tag-or-commit> dengan revisi tepat yang sudah Anda tinjau
python -m pip install "git+https://github.com/devalltect00/Custy.git@<tag-or-commit>"

Menghilangkan @<tag-or-commit> akan mengikuti branch default repositori dan menghasilkan instalasi yang kurang reproducible.

---

Instalasi Editable untuk Developer

Kontributor yang mengembangkan Custy itu sendiri sebaiknya menginstal source tree dalam mode editable dengan dependensi development yang dinyatakan dalam pyproject.toml.

Instalasi editable dengan tool development

bash

python -m pip install -e ".[dev]"

Gunakan python -m pip install -e . hanya jika Anda memerlukan kode runtime editable tanpa tool development opsional. Tambahkan docs saat mengerjakan source MkDocs lama milik Custy: python -m pip install -e ".[dev,docs]".

💡Mengapa menggunakan python -m pip?

Menjalankan pip melalui python -m pip memastikan instalasi menggunakan interpreter Python dari virtual environment yang aktif.

---

Helper Makefile Opsional

Makefile repositori dapat membuat environment venv/ standar dan menjalankan target instalasi editable. Helper ini ditujukan untuk source checkout Custy dan memerlukan GNU Make.

Penyiapan kontributor dengan Make

bash

make venv
make upgrade-pip
make install-dev

• make install menginstal dependensi runtime dalam mode editable.
• make install-dev menambahkan grup dependensi development.
• make install-all menambahkan tool development dan dokumentasi lama.
• Make hanya merupakan lapisan bantu; perintah python -m pip yang setara tetap dapat digunakan tanpa Make.

---

Verifikasi Instalasi

📌Pemeriksaan Instalasi

• Environment yang dimaksud sudah aktifRequired

  Shell Anda menemukan Python dan Custy dari virtual environment atau instalasi yang dipilih.

• Versi Python kompatibelRequired

  python --version menampilkan Python 3.14 atau lebih baru untuk penggunaan native.

• Versi yang terinstal dapat dilihatRequired

  custy --version menampilkan informasi versi package.

• Bantuan perintah dapat ditampilkanRequired

  custy --help menampilkan perintah publik dan opsi global.

Verifikasi CLI

bash

python --version
git --version
custy --version
custy --help

Dari source checkout, python -m app --help adalah entry point modul alternatif untuk membedakan masalah PATH dari masalah aplikasi.

---

Masalah Instalasi yang Umum

⚠️Versi Python terlalu lama

Jika pip melaporkan versi Python yang tidak kompatibel, instal Python 3.14 atau lebih baru, buat ulang virtual environment dengan interpreter tersebut, lalu instal kembali.

⚠️custy tidak dikenali

Pastikan virtual environment yang dimaksud sudah aktif. Anda juga dapat menjalankan executable secara langsung, misalnya venv\Scripts\custy.exe --help di Windows, atau menggunakan python -m app --help dari source checkout.

⚠️Perintah Git tidak tersedia

Instal Git dan pastikan git --version berfungsi di shell yang sama. Instalasi package Python yang berhasil tidak menyediakan executable Git yang diperlukan oleh alur kerja utama Custy.

---

Lanjutkan

🚀Related Commands

Commands commonly used together with this command.

Penyiapan Docker

Build image Custy mandiri yang sudah menyertakan Python, Git, pip, dan Make.

Mulai Cepat

Inisialisasi dan validasi repositori yang sudah ada.

Penyiapan Developer

Siapkan dan verifikasi environment kontributor editable.

custy init

Buat resource Custy khusus proyek.

custy validate

Periksa kesiapan proyek sebelum menjalankan pipeline.