Cài đặt

Cài và chạy memo đầu tiên trong vài phút

Bạn cần Python 3.11 trở lên, Git, và quyền truy cập repo riêng của dự án. Công cụ chỉ dùng thư viện chuẩn của Python, chạy tốt nhất trên Windows.

Chuẩn bị

Repo ở chế độ riêng tư: bạn chỉ tải được sau khi tác giả cấp quyền cho tài khoản GitHub của bạn.

1

Xin quyền truy cập

Liên hệ tác giả qua ducnguyen.vn, gửi tên tài khoản GitHub để được thêm vào repo.

2

Kiểm Python và Git

Dòng đầu phải là Python 3.11 hoặc mới hơn.

Terminal
python --version
git --version
3

Lấy mã nguồn bản 0.1.0

Git sẽ hỏi đăng nhập GitHub bằng tài khoản đã được cấp quyền.

Terminal
# bản 0.1.0
git clone https://github.com/ducnguyen221/agent-finance-legal-team.git agent-finance-legal-team-0.1.0
cd agent-finance-legal-team-0.1.0

Chọn cách chạy

Hai cách cho cùng một kết quả; chọn theo việc bạn có muốn gọi lệnh từ thư mục khác hay không.

CáchKhi nào chọnCách gọi
Chạy từ thư mục mã nguồnThử nhanh, không cài gì thêm.python -m finance_legal … khi đang đứng trong thư mục repo
Cài vào môi trường ảoMuốn gọi từ bất kỳ thư mục nào, tách khỏi Python hệ thống.python -m finance_legal … sau khi bật môi trường ảo

Cài vào môi trường ảo

Bỏ qua phần này nếu bạn chỉ chạy từ thư mục mã nguồn. Bước cài cần mạng một lần để tải công cụ đóng gói; khi chạy thì không.

Trong thư mục agent-finance-legal-team-0.1.0
python -m venv .venv
# Windows PowerShell
.venv\Scripts\Activate.ps1
# macOS / Linux
source .venv/bin/activate

python -m pip install .
python -m pip show agent-finance-legal-team   # phải thấy: Version: 0.1.0

Kiểm là đã cài đúng

Chạy với fixture mẫu, xuất memo ra thư mục tạm. Đúng thì lệnh không in gì và file memo xuất hiện.

Windows PowerShell — trong thư mục repo
python -m finance_legal tests\fixtures\valid.json "$env:TEMP\memo-kiem-cai-01.md"
echo $LASTEXITCODE   # phải là 0
Get-Content "$env:TEMP\memo-kiem-cai-01.md" -TotalCount 7 -Encoding UTF8
macOS / Linux — trong thư mục repo
python -m finance_legal tests/fixtures/valid.json "${TMPDIR:-/tmp}/memo-kiem-cai-01.md"
echo $?   # phải là 0
head -n 7 "${TMPDIR:-/tmp}/memo-kiem-cai-01.md"

Đạt khi: mã thoát là 0 và memo có dòng Trạng thái: needs_review cùng Tài chính: available; variance: 20.00.

Dùng trên macOS hoặc Linux

Cảnh báo: ngoài Windows, công cụ vẫn chặn đường dẫn mạng dạng UNC, symlink và đường dẫn lạ, nhưng không nhận ra thư mục mạng được mount (NFS, SMB) và chưa được kiểm trên các nền này. Chỉ đọc và ghi trong thư mục cục bộ trên máy bạn.

Nâng cấp và gỡ

Nâng cấp

Kéo bản mới về, rồi cài lại nếu bạn dùng môi trường ảo.

Trong thư mục repo
git pull
python -m pip install .

Gỡ

Gỡ gói khỏi môi trường ảo, sau đó xoá thư mục repo nếu không dùng nữa.

Môi trường ảo đang bật
python -m pip uninstall agent-finance-legal-team

Lỗi hay gặp

Git báo «Repository not found» khi tải?

Đăng nhập GitHub bằng đúng tài khoản đã được cấp quyền. Repo riêng tư hiện như không tồn tại với tài khoản chưa có quyền.

Chạy lại thì nhận OUTPUT_ERROR?

Đặt tên file memo mới. Công cụ không bao giờ ghi đè file đã có, và không tự tạo thư mục cha.

Nhận INPUT_ERROR dù file có thật?

Chuyển file vào ổ đĩa cục bộ. Đường dẫn mạng, ổ mạng ánh xạ, ổ subst, symlink và đường có .. đều bị từ chối.

Ổ USB báo OUTPUT_ERROR?

Ghi memo ra ổ hỗ trợ hardlink, ví dụ ổ NTFS của máy. Ổ định dạng FAT hoặc exFAT không xuất được.

Python báo lỗi cú pháp hoặc thiếu module?

Kiểm python --version là 3.11 trở lên, và bạn đang đứng trong thư mục repo hoặc đã bật môi trường ảo.

Cài xong rồi?

Xem cách đọc memo và cách soạn fixture của riêng bạn.