voxrow 0.9.36

VOXROW's library

VOXROW

Daftar isi:

• VOXROW
  • Instalasi dan Cara Penggunaan VOXROW
    • MacOS Hanya Jika Error
  • Server
  • Source-code
    • Editor
    • Repositori Git
    • Tata Cara Penulisan Markdown
    • Python
  • Lisensi

---

Instalasi dan Cara Penggunaan VOXROW

$ pip install voxrow

Contoh cara penggunaan VOXROW dapat dilihat di example/example.ipynb.

MacOS (Hanya Jika Error)

Pastikan clang sudah terinstal. Jika tidak, maka jalankan perintah berikut ini:

$ xcode-select --install

Instal VOXROW dengan perintah berikut ini:

$ brew install openssl@3 rust && env LDFLAGS="-L$(brew --prefix openssl@3)/lib" CFLAGS="-I$(brew --prefix openssl@3)/include" pip install "voxrow[query]"

Server

Disarankan untuk menggunakan Ubuntu 18.04 x64 (CPU minimal 1 vCore, RAM minimal 512 MB, Storage minimal 10 GB SSD, dan Bandwidth minimal 500 GB), supaya memudahkan pengelolaan server dengan mengunakan script VOXROW. Adapun langkah yang harus dipersiapkan adalah sebagai berikut:

1. Pastikan telah ada source-code VOXROW di komputer lokal dan server. Dapat dipergunakan perintah Git berikut ini:

   $ git clone --recurse-submodules -j8 https://gitlab.com/voxrow/library.git
   

   Jangan jalankan perintah ini di folder root/ milik server!

2. Masuk ke folder server/:

   $ cd voxrow/src/server/
   

3. Pastikan GNU Make sudah ada, dengan menjalankan perintah ini:

   $ . install/make_gnu.sh
   

   Script ini hanya dapat dipergunakan di Ubuntu Linux, instalasi untuk OS selain ini silahkan cari di internet.

4. Jalankan perintah di komputer lokal dan server sebagai berikut:

   • Komputer lokal:

     Pastikan terlebih dahulu bahwa SSH Key Pair sudah dibuat, baca baik-baik instruksi dalam prosesnya! Berikut ini adalah perintahnya:

     $ sudo ssh-keygen
     

     Salin public key komputer lokal ke server dengan perintah ini:

     $ make local_ssh_key_to_server
     

     Ikuti instruksi yang dimintakan saat proses berjalan.

     Masukkan alamat server dan username root.

   • Server:

     Pastikan anda masuk sebagai username root!

     $ make
     

     Ikuti instruksi yang dimintakan saat proses berjalan. Setelah proses berakhir server akan reboot. Selesai reboot masuk kembali dengan username baru yang telah dibuat.

     GitLab CI/CD dipergunakan untuk mempermudah proses release aplikasi. Registrasi GitLab Runner di private server perlu dilakukan untuk proses CI/CD, berikut adalah perintahnya:

     $ make register_runner
     

     Setelah seluruh proses selesai dijalankan, maka hapuslah source-code VOXROW dari server, karena sudah tidak diperlukan lagi. Perintahnya adalah sebagai berikut:

     $ sudo rm -rf voxrow/
     

---

Source-code

Sebagai catatan beberapa perintah aplikasi di komputer lokal ini dapat berjalan dengan baik di OS MacOS dan Linux. Adapun untuk OS Windows perlu dilakukan sedikit penyesuaian.

Editor

VSCode (Visual Studio Code) dipergunakan untuk memudahkan dalam penulisan source-code.

Beberapa extension VSCode dipasangkan untuk memudahkan penulisan source-code, antara lain:

• Auto Markdown TOC
• Markdownlint
• Python extension for Visual Studio Code
• Jinja
• Better TOML

Repositori Git

Git GUI Sourcetree dapat dipergunakan untuk memudahkan pengelolaan repositori, pada sistem operasi Windows atau MacOS.

Branching model Git-Flow dari Vincent Driessen dipergunakan untuk memudahkan pengelolaan feature, release, dan hotfix di dalam repositori.

Tata Cara Penulisan Markdown

Beberapa sumber ini dapat dijadikan acuan tata cara penulisan markdown:

• GitLab: List of supported languages and lexers
• GitLab Markdown
• Wikipedia: Markdown
• Berkas readme.md yang dibuat oleh Ben Strahan

Python

Dipergunakan Python 3.8.0 (versi minimal).

Dalam mengembangkan source-code di komputer lokal, maka pertamakali perlu dibuat environtment python dengan langkah berikut ini:

1. Pastikan versi python yang dipergunakan sudah sesuai.

   $ python3 -V
   

2. Buat environtment python.

   $ python3 -m venv venv
   

   Instruksi terkait environtment python yang dapat dipergunakan antara lain:

   • Aktivasi:

     $ . venv/bin/activate
     

     Kembangkan source-code dengan kondisi environtment python sedang teraktivasi.

   • Deaktivasi:

     (venv) $ deactivate
     

3. Pastikan pustaka pendukung terpasang di environtment python.

   (venv) $ pip install --upgrade pip && pip install -r requirements.txt
   

---

Lisensi

Lisensi yang dipergunakan adalah MS-RSL (Microsoft Reference Source License).