Lewati ke isi

Development

Untuk development indoNLP menggunakan python-poetry untuk packaging dan management dependencies.

Install python-poetry

Silahkan kunjungi installation untuk melihat cara installasi dari python-poetry berdasarkan OS yang digunakan.

Setup

Setup development environment, dengan menggunakan command

$ make setup-dev

Command tersebut akan menginstall semua dependencies yang digunakan oleh indoNLP dalam tahap development.

Makefile Commands

Commands yang terdapat pada Makefile digunakan untuk memudahkan proses development yaitu:

  • setup-dev digunakan untuk setup development environment.
  • format digunakan untuk mengformat menggunakan black dan isort.
  • format-check digunakan untuk melihat apakah project telah mengikuti ketentuan black dan isort.
  • typecheck digunakan untuk type checking menggunakan mypy
  • test digunakan untuk melakukan testing menggunakan pytest

Coverage Target

Code coverage yang ditargetkan pada indoNLP adalah lebih dari 95%.

codecov

codecov-sunburst

pre-commit

Sebelum melakukan commit pastikan kode lolos format-check dan typecheck karena akan diujikan oleh pre-commit, jika tidak lolos maka commit akan ditolak.

Perhatian

Pastikan anda berada dalam environment poetry saat melakukan commit, cara mengaktifkannya adalah dengan menggunakan command

poetry shell