Penambahan fitur bagi pengguna terdaftar

.github/workflows/lint.yml

@@ -31,8 +31,8 @@ jobs:
     - name: Lint with flake8
       run: |
         pip install flake8
-        flake8 kbbi tests --count --ignore=E203 --show-source --statistics
+        flake8 kbbi tests --count --ignore=E203,W503 --show-source --statistics
     - name: Lint with isort
       run: |
         pip install isort
-        isort -c -df -rc -o pytest .
+        isort -c -df -rc -o pytest -p kbbi .

.github/workflows/test.yml

@@ -25,6 +25,9 @@ jobs:
         python -m pip install --upgrade pip
         pip install -r requirements.txt
     - name: Test with pytest
+      env:
+        KBBI_POSEL: ${{ secrets.KBBI_POSEL }}
+        KBBI_SANDI: ${{ secrets.KBBI_SANDI }}
       run: |
         pip install pytest
         pytest

.pre-commit-config.yaml

@@ -9,9 +9,10 @@ repos:
     rev: "3.7.9"
     hooks:
       - id: flake8
-        args: ["--ignore=E203"]
+        args: ["--ignore=E203,W503"]
 
   - repo: https://github.com/timothycrosley/isort
     rev: "4.3.21-2"
     hooks:
       - id: isort
+        args: ["-o=pytest", "-p=kbbi"]

README.md

@@ -140,6 +140,72 @@ tak.sir (2)
 }
 ```
 
+Untuk memanfaatkan fitur khusus pengguna, buat objek `AutentikasiKBBI` terlebih
+dahulu, lalu gunakan objek tersebut dalam pembuatan objek `KBBI`.
+
+```python
+>>> auth = AutentikasiKBBI("[email protected]", "password_saya")
+>>> roh = KBBI("roh", auth)
+>>> print(roh)
+roh
+bentuk tidak baku: ruh
+Etimologi: [Arab] (n) (sg) (f/m)  رُوْحٌ rūh: tiupan; sesuatu yang membuat manusia dapat hidup
+1. (n)  sesuatu (unsur) yang ada dalam jasad yang diciptakan Tuhan sebagai penyebab adanya hidup (kehidupan); nyawa: jika -- sudah berpisah dari badan, berakhirlah kehidupan seseorang
+2. (n)  makhluk hidup yang tidak berjasad, tetapi berpikiran dan berperasaan (malaikat, jin, setan, dan sebagainya)
+3. (n) (ki)  semangat; spirit: kedamaian bagi seluruh warga sesuai dengan -- Islam
+Gabungan Kata
+roh Kudus; roh suci
+```
+
+Fitur khusus pengguna yang didukung saat ini adalah etimologi, entri terkait
+(kata turunan, gabungan kata, peribahasa, dan kiasan), dan batas pencarian yang
+lebih besar.
+
+Untuk mendapatkan representasi `str`-nya tanpa fitur entri terkait, gunakan
+`__str__(terkait=False)`.
+
+```python
+>>> print(roh.__str__(contoh=False, terkait=False))
+roh
+bentuk tidak baku: ruh
+Etimologi: [Arab] (n) (sg) (f/m)  رُوْحٌ rūh: tiupan; sesuatu yang membuat manusia dapat hidup
+1. (n)  sesuatu (unsur) yang ada dalam jasad yang diciptakan Tuhan sebagai penyebab adanya hidup (kehidupan); nyawa
+2. (n)  makhluk hidup yang tidak berjasad, tetapi berpikiran dan berperasaan (malaikat, jin, setan, dan sebagainya)
+3. (n) (ki)  semangat; spirit
+```
+
+Untuk menonaktifkan fitur khusus pengguna (selain batas pencarian yang lebih
+besar), tambahkan argumen `fitur_pengguna=False` pada pemanggilan `__str__`
+atau `serialisasi`.
+
+Apabila ingin menyimpan kuki autentikasi, panggil *method* `simpan_kuki()` pada
+objek `AutentikasiKBBI`.
+
+```python
+>>> auth.simpan_kuki()
+```
+
+Berikutnya, objek `AutentikasiKBBI` dapat dibuat tanpa menggunakan alamat posel
+dan sandi. Autentikasi dilakukan dengan memanfaatkan kuki yang telah disimpan.
+
+```python
+>>> auth_baru = AutentikasiKBBI()
+```
+
+Lokasi penyimpanan/pembacaan kuki bisa diatur dengan parameter `lokasi_kuki`
+ketika membuat objek `AutentikasiKBBI`.
+
+```python
+>>> auth = AutentikasiKBBI("[email protected]", "sandi_saya", lokasi_kuki="~/kuki_kbbi.json")
+>>> auth_baru = AutentikasiKBBI(lokasi_kuki="~/kuki_kbbi.json")
+```
+
+Secara *default*, lokasi tersebut adalah:
+
+- Unix: `~/.config/kbbi/kuki.json`
+- Windows: `%localappdata%\laymonage\kbbi\kuki.json`
+- Mac: `~/Library/Application Support/kbbi/kuki.json`
+
 ### Melalui CLI
 
 ```
@@ -153,7 +219,7 @@ tanda petik.
 $ kbbi "tanggung jawab"
 ```
 
-Apabila tidak ingin menampilkan contoh, gunakan `--tanpa-contoh` atau `-t`.
+Apabila tidak ingin menampilkan contoh, gunakan `--tanpa-contoh` atau `-c`.
 
 ```
 $ kbbi "tanggung jawab" --tanpa-contoh
@@ -173,7 +239,37 @@ atau `-i N`.
 $ kbbi "tanggung jawab" --json --indentasi 2
 ```
 
-> **Catatan:** **`kbbi`** juga bisa dipanggil dengan **`python kbbi.py`**.
+Untuk memanfaatkan fitur khusus pengguna, lakukan autentikasi terlebih dahulu
+dengan bantuan `kbbi-autentikasi`.
+
+```
+$ kbbi-autentikasi $KBBI_POSEL $KBBI_SANDI
+```
+
+Penggunaan `kbbi` berikutnya akan otomatis menggunakan kuki hasil autentikasi.
+
+Untuk menonaktifkan fitur entri terkait, gunakan `--tanpa-terkait` atau `-t`.
+
+```
+$ kbbi alam --tanpa-terkait
+```
+
+Untuk menonaktifkan semua fitur khusus pengguna (selain batas pencarian yang
+lebih besar dan tanpa menghapus kuki), gunakan `--nonpengguna` atau `-n`.
+
+```
+$ kbbi alam --nonpengguna
+```
+
+Untuk menghapus kuki, gunakan opsi `--bersihkan` atau `-c`.
+
+```
+$ kbbi-autentikasi --bersihkan
+```
+
+> **Catatan:**\
+> **`kbbi`** juga bisa dipanggil dengan **`python kbbi.py`**.\
+> **`kbbi-autentikasi`** juga bisa dipanggil dengan **`python -c "import kbbi; kbbi.autentikasi()"`**
 
 ## Berkontribusi