Skip to content

Commit

Permalink
udate reference path
Browse files Browse the repository at this point in the history
  • Loading branch information
thinh-vu committed May 11, 2024
1 parent bd25852 commit 4513d1e
Show file tree
Hide file tree
Showing 14 changed files with 45 additions and 45 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<div align="center">

[![python_course_6](https://raw.githubusercontent.com/thinh-vu/vnstock/beta/docs/docs/assets/images/Python%20Course%206%20-%20Phan%20tich%20du%20lieu%20va%20giao%20dich%20chung%20khoan.png)](https://docs.vnstock.site/course/#khoa-hoc-ang-trien-khai)
[![python_course_6](https://raw.githubusercontent.com/thinh-vu/vnstock/legacy/docs/docs/assets/images/Python%20Course%206%20-%20Phan%20tich%20du%20lieu%20va%20giao%20dich%20chung%20khoan.png)](https://docs.vnstock.site/course/#khoa-hoc-ang-trien-khai)

</div>

---
<div id="logo" align="center">
<a href="http://vnstock.site?utm_source=github&utm_medium=vnstock&utm_content=readme">
<img src="https://raw.githubusercontent.com/thinh-vu/vnstock/beta/docs/docs/assets/images/vnstock_logo_color.png" alt="vnstock_logo"/>
<img src="https://raw.githubusercontent.com/thinh-vu/vnstock/legacy/docs/docs/assets/images/vnstock_logo_color.png" alt="vnstock_logo"/>
</a>
</div>

Expand All @@ -21,7 +21,7 @@
---


🌐 View in **[English](https://github.com/thinh-vu/vnstock/blob/beta/docs/README-en.md)**
🌐 View in **[English](https://github.com/thinh-vu/vnstock/blob/legacy/docs/README-en.md)**

# I. 🎤 Giới thiệu

Expand All @@ -31,7 +31,7 @@ vnstock là thư viện Python được thiết kế để tải dữ liệu ch

Trước khi bắt đầu, hãy đánh dấu yêu thích để giúp dự án có thể tiếp cận tới nhiều người hơn. Cám ơn bạn!

![star_project](https://raw.githubusercontent.com/thinh-vu/vnstock/beta/docs/docs/assets/images/github_star_guide.png)
![star_project](https://raw.githubusercontent.com/thinh-vu/vnstock/legacy/docs/docs/assets/images/github_star_guide.png)

Cài đặt thư viện với câu lệnh sau:

Expand All @@ -43,7 +43,7 @@ pip install -U vnstock

[![vnstock docs - Xem Thêm](https://img.shields.io/badge/vnstock_docs-Xem_Thêm-2ea44f?style=for-the-badge&logo=Github)](https://thinh-vu.github.io/vnstock)

[![vnstock_docs_home](https://raw.githubusercontent.com/thinh-vu/vnstock/beta/docs/docs/assets/images/vnstock_docs_home.png)](https://thinh-vu.github.io/vnstock)
[![vnstock_docs_home](https://raw.githubusercontent.com/thinh-vu/vnstock/legacy/docs/docs/assets/images/vnstock_docs_home.png)](https://thinh-vu.github.io/vnstock)

# III. 🙋‍♂️ Thông tin liên hệ

Expand All @@ -66,7 +66,7 @@ Bạn có thể kết nối với tác giả qua các hình thức sau. Trong tr

# IV. 🔑 Giấy phép (License)

Vnstock được cấp phép theo Giấy phép MIT. Nội dung của giấy phép như dưới đây, và thể hiện trong file [LICENSE](https://github.com/thinh-vu/vnstock/blob/beta/LICENSE).
Vnstock được cấp phép theo Giấy phép MIT. Nội dung của giấy phép như dưới đây, và thể hiện trong file [LICENSE](https://github.com/thinh-vu/vnstock/blob/legacy/LICENSE).

Khi sử dụng Vnstock trong dự án của mình, bạn phải tuân thủ và giữ nguyên giấy phép MIT của Vnstock. Đồng thời, hãy chắc chắn rằng bạn đã bao gồm tên tác giả và giấy phép trong dự án của bạn.

Expand Down
46 changes: 23 additions & 23 deletions docs/README-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This Python library connects to public APIs of data providers to download data a
<details>
<summary> Minh họa tính năng Watch và Star </summary>

![watch-star](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/vnstock-watch-and-star.png?raw=true)
![watch-star](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/vnstock-watch-and-star.png?raw=true)

</details>

Expand All @@ -58,7 +58,7 @@ You can contribute to the development of vnstock through various means, includin
👉 For more information and illustrations on how to use, please visit the blog post, available in Vietnamese/English [here](https://thinhvu.com/2022/09/22/vnstock-api-tai-du-lieu-chung-khoan-python?utm_source=github&utm_medium=vnstock).

### 2.1.2 Notebook Illustration
👉 You can open the Jupyter Notebook file [vnstock_demo_index_all_functions_testing](https://github.com/thinh-vu/vnstock/blob/beta/demo/gen2_vnstock_demo_index_all_functions_testing_2023_07_07.ipynb) to try out all the functions of vnstock. To use, click the ![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg) button at the top of the notebook to open it with Google Colab.
👉 You can open the Jupyter Notebook file [vnstock_demo_index_all_functions_testing](https://github.com/thinh-vu/vnstock/blob/legacy/demo/gen2_vnstock_demo_index_all_functions_testing_2023_07_07.ipynb) to try out all the functions of vnstock. To use, click the ![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg) button at the top of the notebook to open it with Google Colab.

### 2.1.3. Docstring
All functions of vnstock are provided with complete docstrings, while this README.md file may not include a full description of the parameters allowed for each function. You can refer to the code hints when writing commands in IDEs like Google Colab, Visual Studio Code, or Jupyter Notebook, or open the source code on Github for more details. In the future, vnstock will provide full descriptions in the README.md when possible.
Expand All @@ -67,16 +67,16 @@ All functions of vnstock are provided with complete docstrings, while this READM
<summary>Docstring in Google Colab</summary>
Syntax hints for functions are displayed when writing any function belonging to vnstock. In this example, it is shown in the Google Colab interface.

![docstring_ide](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/docstring_suggestion.jpeg?raw=true)
![docstring_ide](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/docstring_suggestion.jpeg?raw=true)

</details>

<details>
<summary>Docstring in source code</summary>

Open the source code file [vnstock.py](https://github.com/thinh-vu/vnstock/blob/beta/vnstock/stock.py) and find the function you want to look up the docstring for.
Open the source code file [vnstock.py](https://github.com/thinh-vu/vnstock/blob/legacy/vnstock/stock.py) and find the function you want to look up the docstring for.

![docstring_source](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/docstring_source_code.png?raw=true)
![docstring_source](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/docstring_source_code.png?raw=true)

</details>

Expand All @@ -88,8 +88,8 @@ All functions of vnstock are provided with complete docstrings, while this READM
<summary>Supporting the vnstock Development Fund</summary>
If vnstock has been helpful to you, you can contribute to the development fund of this application through either bank transfer or Momo. All contributions are greatly appreciated and serve as motivation for the author to maintain vnstock as a useful, free, and accessible resource for the community.

- ![vcb-qr](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/vcb-qr-thinhvu-vnstock.jpg?raw=true)
- ![momo-qr](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/momo-qr-thinhvu.jpeg?raw=true)
- ![vcb-qr](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/vcb-qr-thinhvu-vnstock.jpg?raw=true)
- ![momo-qr](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/momo-qr-thinhvu.jpeg?raw=true)

</details>

Expand All @@ -99,7 +99,7 @@ All functions of vnstock are provided with complete docstrings, while this READM

### 2.1.6. Notes

👉 Starting from version 0.1.3, all updates regarding features and enhancements for the library are compiled in the [Changelog](https://github.com/thinh-vu/vnstock/blob/beta/changes_log.md) file.
👉 Starting from version 0.1.3, all updates regarding features and enhancements for the library are compiled in the [Changelog](https://github.com/thinh-vu/vnstock/blob/legacy/changes_log.md) file.

## 2.2 🛠 Installing vnstock
### Step 1. Choose the appropriate version
Expand All @@ -118,13 +118,13 @@ All functions of vnstock are provided with complete docstrings, while this READM
<details>
<summary> Choose the appropriate branch </summary>

![select_branch](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/vnstock_select_branch.jpeg?raw=true)
![select_branch](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/vnstock_select_branch.jpeg?raw=true)

</details>

### Step 2. Run the installation command

> When using the demo file [vnstock_demo_index_all_functions_testing_2023_06_22.ipynb](https://github.com/thinh-vu/vnstock/blob/beta/demo/gen2_vnstock_demo_index_all_functions_testing_2023_07_07.ipynb) to get started, the necessary installation commands are provided for you to execute (run).
> When using the demo file [vnstock_demo_index_all_functions_testing_2023_06_22.ipynb](https://github.com/thinh-vu/vnstock/blob/legacy/demo/gen2_vnstock_demo_index_all_functions_testing_2023_07_07.ipynb) to get started, the necessary installation commands are provided for you to execute (run).
**pip is used to install vnstock**. pip is available in most Python distributions. The minimum required Python version for vnstock is 3.7. You can paste the command you copied in Step 1 and run it in your Python environment.

Expand Down Expand Up @@ -219,7 +219,7 @@ You can download the price table of a selected list of stocks to facilitate anal
<details>
<summary>Price Table</summary>

![price_board](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images//tcbs_trading_board_sector.png?raw=true)
![price_board](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images//tcbs_trading_board_sector.png?raw=true)

</details>

Expand All @@ -246,8 +246,8 @@ Using this function allows you to analyze price depth and volume on the price ta
<details>
<summary>Intraday view on TCBS</summary>

![intraday](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images//tcbs_intraday_screen1.png?raw=true)
![intraday](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images//tcbs_intraday_screen2.png?raw=true)
![intraday](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images//tcbs_intraday_screen1.png?raw=true)
![intraday](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images//tcbs_intraday_screen2.png?raw=true)

</details>
vnstock allows the user to **download intraday real-time/historical data**. In
Expand Down Expand Up @@ -353,7 +353,7 @@ industry_analysis("VNM")
<details>
<summary>Output</summary>

![preview](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/stock_comparison_industries.png?raw=true)
![preview](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/stock_comparison_industries.png?raw=true)

```
>>> industry_analysis("VNM")
Expand All @@ -373,7 +373,7 @@ stock_ls_analysis("TCB, BID, CEO, GMD")
<details>
<summary>Output</summary>

![preview](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/stock_ls_comparison.png?raw=true)
![preview](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/stock_ls_comparison.png?raw=true)

```
ticker marcap price numberOfDays priceToEarning peg priceToBook valueBeforeEbitda dividend ... debtOnEbitda income5year sale5year income1quarter sale1quarter nextIncome nextSale rsi rs
Expand Down Expand Up @@ -438,7 +438,7 @@ financial_report (symbol='SSI', report_type='BalanceSheet', frequency='Quarterly

##### 📄 Income Statement

![income_statement](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images//financial_income_statement.png?raw=true)
![income_statement](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images//financial_income_statement.png?raw=true)
```python
financial_flow(symbol="TCB", report_type='incomestatement', report_range='quarterly')
```
Expand All @@ -459,7 +459,7 @@ index

##### 🧾Balance Sheet

![balance_sheet](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images//financial_balancesheet.png?raw=true)
![balance_sheet](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images//financial_balancesheet.png?raw=true)
```python
financial_flow(symbol="TCB", report_type='balancesheet', report_range='quarterly')
```
Expand Down Expand Up @@ -611,10 +611,10 @@ industry_financial_health("VNM")
<summary>SSI Top Stocks</summary>

Top Breakout > Top Gainers > Top Losers > Top Value > Top Volume
![top_mover](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/ssi_top_breakout_gainer_loser.png?raw=true)
![top_mover](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/ssi_top_breakout_gainer_loser.png?raw=true)

Top New High > Top Foreign Trading > Top New Low
![top_foreigntrading_high_low](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/top_foreigntrading_newhigh_newlow.png?raw=true)
![top_foreigntrading_high_low](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/top_foreigntrading_newhigh_newlow.png?raw=true)

</details>

Expand Down Expand Up @@ -661,7 +661,7 @@ fr_trade_heatmap ('All', 'FrBuyVol')
</details>

### 2.15.3. Market latest indices & values
![latest_indices](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images//get_latest_indices.png?raw=true)
![latest_indices](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images//get_latest_indices.png?raw=true)

Retrieve the latest indices values & brief insights

Expand Down Expand Up @@ -704,7 +704,7 @@ get_latest_indices()
</details>

### 2.15.4. Market latest indices in depth data
![index_series_data](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images//get_index_series_data.png?raw=true)
![index_series_data](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images//get_index_series_data.png?raw=true)

```python
get_index_series(index_code='VNINDEX', time_range='OneYear')
Expand Down Expand Up @@ -776,8 +776,8 @@ If you find value in vnstock and my open-source projects, you can support their
You have three options to contribute: Momo, Bank Transfer, and Paypal. Your contribution will help me cover the hosting fees for my blog and continue creating high-quality content. Thank you for your support!

- [Paypal](https://paypal.me/thinhvuphoto?country.x=VN&locale.x=en_US)
- ![momo-qr](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/momo-qr-thinhvu.jpeg)
- ![vcb-qr](https://github.com/thinh-vu/vnstock/blob/beta/docs/assets/images/vcb-qr-thinhvu.jpg)
- ![momo-qr](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/momo-qr-thinhvu.jpeg)
- ![vcb-qr](https://github.com/thinh-vu/vnstock/blob/legacy/docs/assets/images/vcb-qr-thinhvu.jpg)

# VI. ⚖ Disclaimer
vnstock is designed solely for the purpose of analysis and practical investment research. Any misuse or unauthorized use of the library for malicious purposes, such as attacking public APIs or causing harm to systems through denial of service or similar actions, is strictly beyond the intended scope of usage and falls outside the responsibility of the development team.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/changes_log.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Thử nghiệm thành công và ra mắt phiên bản thử nghiệm 1.0 cho tra

## 22-07-2023

- Bổ sung hướng dẫn vào [Demo Notebook](https://github.com/thinh-vu/vnstock/blob/beta/demo/gen2_vnstock_demo_index_all_functions_testing_2023.ipynb) giúp người dùng xuất dữ liệu từ Google Colab ra Google Sheets.
- Bổ sung hướng dẫn vào [Demo Notebook](https://github.com/thinh-vu/vnstock/blob/legacy/demo/gen2_vnstock_demo_index_all_functions_testing_2023.ipynb) giúp người dùng xuất dữ liệu từ Google Colab ra Google Sheets.

## 14-07-2023

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/community/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Tôi hướng đến một môi trường trao đổi thân thiện, tích cực
- Để lại comment cho các đoạn mã bạn cung cấp giúp các thành viên khác hiểu được logic thiết kế và bắt kịp ý tưởng của bạn tốt hơn.

## Bản quyền và giấy phép
- Bằng cách đóng góp vào dự án Vnstock, bạn đồng ý rằng đóng góp của bạn sẽ được công bố tự do theo giấy phép [MIT License](https://github.com/thinh-vu/vnstock/blob/beta/LICENSE).
- Vui lòng thêm tên của bạn vào phần "Người đóng góp" trong tệp [CONTRIBUTORS.md](https://github.com/thinh-vu/vnstock/blob/beta/CONTRIBUTORS.md).
- Bằng cách đóng góp vào dự án Vnstock, bạn đồng ý rằng đóng góp của bạn sẽ được công bố tự do theo giấy phép [MIT License](https://github.com/thinh-vu/vnstock/blob/legacy/LICENSE).
- Vui lòng thêm tên của bạn vào phần "Người đóng góp" trong tệp [CONTRIBUTORS.md](https://github.com/thinh-vu/vnstock/blob/legacy/CONTRIBUTORS.md).

Chúng tôi cảm ơn sự đóng góp của bạn cho Vnstock. Nhóm phát triển sẵn lòng hỗ trợ và xem xét mọi đóng góp để nâng cao chất lượng và tính năng của dự án. Hãy cùng nhau tạo nên một công cụ mạnh mẽ hỗ trợ đầu tư chứng khoán Việt Nam! 🚀
2 changes: 1 addition & 1 deletion docs/docs/functions/listing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ listing_companies(live=True)
Trong đó:

- Tham số `live` nhận một trong hai giá trị.
- `live=False`: Cho phép đọc dữ liệu cục bộ từ tệp csv [listing_companies](https://raw.githubusercontent.com/thinh-vu/vnstock/beta/data/listing_companies_enhanced-2023.csv) đính kèm trên Github theo mặc định. File này được cập nhật hàng tháng. Chứa thông tin rất chi tiết. Bởi danh sách các công ty niêm yết thường không thay đổi liên tục nên việc này không gây trở ngại nhiều.
- `live=False`: Cho phép đọc dữ liệu cục bộ từ tệp csv [listing_companies](https://raw.githubusercontent.com/thinh-vu/vnstock/legacy/data/listing_companies_enhanced-2023.csv) đính kèm trên Github theo mặc định. File này được cập nhật hàng tháng. Chứa thông tin rất chi tiết. Bởi danh sách các công ty niêm yết thường không thay đổi liên tục nên việc này không gây trở ngại nhiều.

- `live=True`: Cho phép đọc dữ liệu danh sách công ty niêm yết được cập nhật realtime từ API miễn phí do Wifeed cung cấp. Dữ liệu được trả về trong trường hợp này chỉ gồm 4 thông tin cơ bản: mã CK, tên công ty, mã phân loại công ty, sàn niêm yết.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/integrate/dnse_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

vnstock cung cấp phương thức kết nối với API DNSE hoàn chỉnh để đọc thông tin, đặt/chỉnh sửa/hủy lệnh giao dịch.

Để bắt đầu sử dụng, các bạn cần cài đặt gói thư viện vnstock mới nhất v0.2.8.1 có hỗ trợ đầy đủ các chức năng cho DNSE Lightspeed API. Từ các hàm python này, các bạn có thể xây dựng bot giao dịch/web app dễ dàng từ môi trường cloud hoặc máy tính cá nhân. Xem thêm [mã nguồn](https://github.com/thinh-vu/vnstock/blob/beta/vnstock/integration.py) để lấy cảm hứng.
Để bắt đầu sử dụng, các bạn cần cài đặt gói thư viện vnstock mới nhất v0.2.8.1 có hỗ trợ đầy đủ các chức năng cho DNSE Lightspeed API. Từ các hàm python này, các bạn có thể xây dựng bot giao dịch/web app dễ dàng từ môi trường cloud hoặc máy tính cá nhân. Xem thêm [mã nguồn](https://github.com/thinh-vu/vnstock/blob/legacy/vnstock/integration.py) để lấy cảm hứng.

[Xem hướng dẫn :material-rocket-launch:](../start/huong-dan-su-dung-nhanh-vnstock.md){ .md-button }

Expand Down
Loading

0 comments on commit 4513d1e

Please sign in to comment.