Hướng dẫn cách Gen Document Design bằng code Python

by DaoNM2
49 views

Hi các bạn, có bao giờ các bạn gặp phải tình huống khi kết thúc dự án thì phải làm Document design cho dự án của mình? Yêu cầu phải liệt kê hết các func trong project ra file excel và giải thích nó làm gì. Nếu câu trả lời là có thì các bạn có thể đọc tiếp bài viết này để xem cách thực hiện nó như thế nào nhé.

Yêu cầu

  • Cần liệt kê hết tất cả các func trong souce code và giải thích func đó dùng để làm gì
  • Định dạng yêu cầu theo file excel

Chuẩn bị

Do tool được code trên nền tảng python nên mọi người cần cài đặt Python3 trước để có thể thực hiện gen document. Để cài đặt thì mọi người có thể làm theo hướng dẫn sau:

1. Homebrew

Link tham khảo: https://brew.sh v/bin/bash -c “$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)”

2. Install Python 3 on Mac – Brew Install

Link tham khảo: https://www.freecodecamp.org/news/python-version-on-mac-update/ vbrew install pyenv // Install vpyenv install 3.9.2 // Update version

3. Install pip: pip la một package của Python

Link tham khảo: https://pip.pypa.io/en/stable/

Download get-pip.py provided by https://pip.pypa.io hoặc sử dung terminal: vcurl https://bootstrap.pypa.io/get-pip.py -o get-pip.py vsudo python3 get-pip.py

4. Openpyxl install: Cài đặt openpyxl sử dụng pip.

Link tham khảo: https://openpyxl.readthedocs.io/en/stable/ vsudo pip install openpyxl

5. Tải sẵn file template ở đây:

File design là file excel template
File DocC+.py là file code python nhằm mục đích gen gen souce và update file excel.

NOTE: Đây là code dùng để gen dự án sử dụng ngôn ngữ lập trình swift, nếu các bạn cần gen trên ngôn ngữ khác chúng ta sẽ cần thực hiện chỉnh sửa file DocC+.py cho phù hợp với ngôn ngữ mà bạn sử dụng.

Hướng dẫn sử dụng

Bước 1: Copy file DocC+.py và design.xlsx vào trong thư mục cần gen.

Bước 2: Bật Terminal -> navigate đến project folders chữa file DocC+.py

Bước 3: Chạy câu lệnh dưới đây: python3 DocC+.py

Vậy là chúng ta đã gen xong file liệt kê tất cả các func có trong thư mục mà các bạn chọn. Rất nhanh gọn và tiện lợi đúng không?

Ưu điểm

  • Tiết kiệm rất nhiều thời gian thực hiện, thay vì phải copy bằng tay mất rất nhiều thời gian và khiến người thực hiện khá stress thì tool giúp chúng ta làm nó trong vài phút
  • Có thể sử dụng cho tất cả các ngôn ngữ lập trình
  • Quá dễ sử dụng

Tổng kết

Vậy là bài viết trên mình đã giới thiệu, chia sẻ và hướng dẫn các bạn sử dụng một tool cực kì hữu dụng và dễ sử dụng. Mình hi vọng nó sẽ giúp các bạn giải quyết bài toán mà bạn gặp phải. Chúc các bạn thành công!

Leave a Comment

* By using this form you agree with the storage and handling of your data by this website.

You may also like