Skip to content
This repository has been archived by the owner on Jan 18, 2025. It is now read-only.

Commit

Permalink
docs: note more way to use (with uv, just)
Browse files Browse the repository at this point in the history
Adjust minor website appearance
  • Loading branch information
KevinNitroG committed Jan 15, 2025
1 parent 877d934 commit c789ae4
Show file tree
Hide file tree
Showing 8 changed files with 142 additions and 89 deletions.
File renamed without changes.
13 changes: 13 additions & 0 deletions docs/usage/from-source/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# From source

Có thể sử dụng:

- pip (Chỉ cần cài python)
- uv (Cài uv)
- uv và just (Cài uv và just)

## Clone repo

```sh
git clone https://github.com/NTGNguyen/check-phat-nguoi.git
```
61 changes: 61 additions & 0 deletions docs/usage/from-source/pip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Pip

## Yêu cầu

- [Python](https://www.python.org/downloads/) (>=3.13)

---

## Cài đặt dependencies

### Thiết lập môi trường ảo

#### Tạo môi trường ảo

```sh
python -m venv .venv
```

#### Kích hoạt môi trường ảo

=== "Windows"

```powershell
.venv\Scripts\activate
```

=== "Unix / MacOS"

```sh
source .venv/bin/activate
```

#### Cài đặt dependencies

```sh
pip install -r requirements/requirements.txt
```

???- info "Tắt môi trường ảo"

Để tắt môi trường khi không sử dụng chạy `deactivate`

---

## Chạy chương trình

!!! important ""

Yêu cầu kích hoạt venv

=== "Trực tiếp"

```sh
check-phat-nguoi
```

=== "Python module"

```sh
python -m check-phat-nguoi
```
23 changes: 23 additions & 0 deletions docs/usage/from-source/uv-just.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# uv & just

## Yêu cầu

!!! info ""

Giống uv

- [just](https://github.com/casey/just)

## Chạy chương trình

```sh
just
```

???+ info

Just sẽ tự thiết lập môi trường và restore dependencies trước khi chạy.

???+ danger

Just restore tất cả các dependencies khiến môi trường nặng
19 changes: 19 additions & 0 deletions docs/usage/from-source/uv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# uv

## Yêu cầu

- [uv](https://github.com/astral-sh/uv)

## Thiết lập môi trường và dependencies

```sh
uv sync --no-dev
```

## Chạy chương trình

```sh
uv run check-phat-nguoi # (1)
```

1. Có thể thêm arg `--frozen` để không mutate lock file
86 changes: 0 additions & 86 deletions docs/usage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

## Yêu cầu

- [Python](https://www.python.org/downloads/)
- [Tesseact OCR CLI](https://tesseract-ocr.github.io/tessdoc/Installation.html)[Tesseact data set](https://github.com/tesseract-ocr/tessdata) _(Không bắt buộc)_(1)
{ .annotate }

Expand All @@ -12,88 +11,3 @@

- Hiện tại API từ csgt.vn không đảm bảo hoạt động.
- checkphatnguoi.vn không cho truy cập từ IP nước ngoài? (Ảnh hưởng github action)

---

## Clone repo

```sh
git clone https://github.com/NTGNguyen/check-phat-nguoi.git
```

---

## Cài đặt dependencies

### Thiết lập môi trường ảo

#### Tạo môi trường ảo

```sh
python -m venv .venv
```

#### Kích hoạt môi trường ảo

=== "Windows"

```powershell
.venv\Scripts\activate
```

=== "Unix / MacOS"

```sh
source .venv/bin/activate
```

#### Cài đặt dependencies

```sh
pip install -r requirements/requirements.txt
```

???- info "Tắt môi trường ảo"

Để tắt môi trường khi không sử dụng chạy `deactivate`

---

## Sử dụng chương trình

### Thiết lập file config

Thiết lập file `config.json` (1)
{ .annotate }

1. Hoặc
- `check-phat-nguoi.config.json` tại nơi đang đứng
- `~/check-phat-nguoi.config.json`

!!! info

Xem [Config Schema](https://ntgnguyen.github.io/check-phat-nguoi/schemas/config.html) để biết chi tiết config

??? example

```json title="config.json"
--8<-- "config.sample.json"
```

### Chạy chương trình

!!! important ""

Yêu cầu kích hoạt venv

=== "Trực tiếp"

```sh
check-phat-nguoi
```

=== "Python module"

```sh
python -m check-phat-nguoi
```
18 changes: 18 additions & 0 deletions docs/usage/setup-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Thiết lập file config

Thiết lập file `config.json` (1)
{ .annotate }

1. Hoặc
- `check-phat-nguoi.config.json` tại nơi đang đứng
- `~/check-phat-nguoi.config.json`

!!! info

Xem [Config Schema](https://ntgnguyen.github.io/check-phat-nguoi/schemas/config.html) để biết chi tiết config

???+ example "Config mẫu"

```json title="config.json"
--8<-- "config.sample.json"
```
11 changes: 8 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ nav:
- 'Trang chủ': index.md
- 'Sử dụng':
- usage/index.md
- usage/schedule-run.md
- usage/setup-config.md
- 'From source':
- usage/from-source/index.md
- usage/from-source/pip.md
- usage/from-source/uv.md
- usage/from-source/uv-just.md
- 'Nâng cao':
- usage/advanced/schedule-run.md
- 'Config schema': 'https://ntgnguyen.github.io/check-phat-nguoi/schemas/config.html'
- 'Development':
- dev/setup.md
Expand All @@ -24,8 +31,6 @@ nav:

theme:
language: vi
icon:
annotation: material/arrow-right-circle
features:
- navigation.instant
- navigation.instant.progress
Expand Down

0 comments on commit c789ae4

Please sign in to comment.