Hướng dẫn nhanh¶
Giới thiệu chung¶
vnstock là thư viện Python được thiết phục vụ nhu cầu phân tích dữ liệu thị trường chứng khoán Việt Nam, nền móng đầu tiên của thư viện bắt đầu từ việc hỗ trợ tải dữ liệu chứng khoán nhanh chóng, và miễn phí. Gói thư viện được thiết kế dựa trên nguyên tắc về sự đơn giản và tiện lợi, hầu hết các hàm đều có thể chạy ngay trên Google Colab khi cài đặt vnstock mà không yêu cầu thêm gói phụ thuộc.
- vnstock sắp chạm mốc 100K lượt download trong tháng 3/2024 trên nền tảng phân phối gói python - PyPI sau 2 năm ra mắt. Lượt download trong tháng 12/2023 đạt mốc kỷ lục 15.4K kể từ lúc phát hành và 2X so với tháng 11 và tiếp tục tăng trưởng ổn định. Đây là một dấu mốc đáng nhớ của vnstock nhờ sự đón nhận của bạn & cộng đồng!
Cài đặt nhanh¶
Để bắt đầu sử dụng vnstock, bạn sử dụng câu lệnh cài đặt đơn giản sau trên Google Colab hoặc Command Prompt/Terminal:
Hoặc chỉ cần mở file Demo Notebook với Google Colab, chạy lần lượt các câu lệnh để trải nghiệm các tính năng của vnstock.
Mới làm quen với Python?¶
Nếu bạn mới bắt đầu tìm hiểu Python và còn choáng ngợp với quá nhiều thứ mới mẻ thì dự án LEarn Anything từ cùng tác giả Thịnh Vũ sẽ là cẩm nang không thể thiếu cho bạn. Thông qua các bài viết và video hướng dẫn về Python dễ hiểu, bạn sẽ có một cái nhìn tổng quát và cũng rất dễ hiểu để bước chân vào hành trình khám phá một thế giới đầy mê hoặc của python trong mọi lĩnh vực của cuộc sống, không chỉ riêng thị trường chứng khoán.
Nguồn cấp dữ liệu¶
Thư viện vnstock cung cấp khả năng kết nối tới các API công khai của các nguồn cấp dữ liệu đáng tin cậy để người dùng có thể truy xuất dữ liệu chứng khoán Việt Nam và tương tác với các đối tượng Pandas DataFrame trong môi trường Python. Bạn cũng có thể xuất dữ liệu sang các định dạng phổ thông như csv, Excel, Google Sheets, Database để tiến hành phân tích nếu muốn. Việc truy xuất dữ liệu này là TỰ DO và hoàn toàn MIỄN PHÍ.
Đánh dấu yêu thích¶
- Giúp vnstock đạt mục tiêu 1000 lượt yêu thích trên Github thông qua việc đánh dấu sao - Star tại trang dự án. Đây cũng là cách các bạn ủng hộ dự án và giúp lan tỏa vnstock đơn giản nhất giúp ích cho cộng đồng.
Sử dụng trang tài liệu tối ưu¶
Dưới đây là các gợi ý để bạn tra cứu trang tài liệu vnstock tối ưu:
-
Tìm kiếm: Bạn có thể sử dụng thanh tìm kiếm trên trang tài liệu để tìm kiếm tài liệu và các nội dung mình quan tâm
-
Chuyển đổi giao diện sáng/tối: Để có trải nghiệm đọc trong điều kiện ánh sáng tốt nhất, bạn có thể chuyển đổi chế độ sáng/tối bằng cách nhấp vào biểu tượng trên đầu trang.
-
Sử dụng bảng mục lục: Thanh điều hướng bên trái cung cấp các đề mục để bạn có thể nhấp vào và di chuyển đến nội dung mình cần dễ dàng.
-
Copy Code: Ở mỗi ô chứa dòng lệnh luôn có biểu tượng copy cho phép bạn click vào và sao chép đoạn mã dễ dàng.
-
Tính năng thuộc Insiders Program: Bạn sẽ bắt gặp biểu tượng 🔐 đối với hướng dẫn dành cho các tính năng nâng cao chỉ dành cho người dùng tài trợ dự án thông qua chương trình Insiders Program. Tham khảo thêm chi tiết tại đây
- Cấu trúc điều hướng trang tài liệu được mô tả trong file cấu hình của mã nguồn tài liệu: mkdocs.yml bắt đầu từ dòng 200.
Docstring¶
Tất cả các hàm của vnstock đều được cung cấp docstring đầy đủ, do đó bạn có thể xem phần gợi ý khi viết câu lệnh trên các IDE như Google Colab, Visual Studio Code, hay Jupyter Notebook.
Sau khi nạp thư viện vnstock vào môi trường làm việc thông qua câu lệnh import, bạn có thể in phần hướng dẫn sử dụng hàm vnstock bất kỳ thông qua thuộc tính __doc__ của hàm đó như sau (dấu __ được tạo bởi 2 dấu _ tức shift -):
>>> print(listing_companies.__doc__)
This function returns the list of all available stock symbols from a csv file or a live api request.
Parameters:
live (bool): If True, return the list of all available stock symbols from a live api request. If False, return the list of all available stock symbols from the Github csv file (monthly update). Default is False.
Returns: df (DataFrame): A pandas dataframe containing the stock symbols and other information.
Tất nhiên, bạn luôn có thể mở phần mã nguồn của vnstock trên Github để xem chi tiết.
Gợi ý cú pháp hàm được hiển thị khi viết bất kỳ hàm nào thuộc vnstock, trong ví dụ này hiển thị trong giao diện Google Colab.
Mở mã nguồn Github tại thư mục vnstock, tìm hàm bạn cần tra cứu docstring.
