twstock

The analytics module provides two main analysis capabilities: basic technical analysis via the Analytics class and the "Best Four Point" (四大買賣點) trading signal analysis via the BestFourPoint class.

Note that Analytics is designed to be inherited by stock.Stock, allowing you to call its methods directly on a stock instance. However, these analyses are only applicable to historical data provided by stock.Stock; they cannot be used for realtime data.

The library uses a fetcher pattern to retrieve data from different exchanges. The Stock class manages these fetchers internally.

BaseFetcher (Base Class): Provides common logic for all fetchers, including:

• fetch(year, month, sid, retry): Fetches stock data for a specific year and month.
• _convert_date(date): Converts Republic of China (ROC) era dates to Gregorian years (e.g., '106/05/01' becomes '2017/05/01').
• _make_datatuple(data): Converts raw daily data into a DATATUPLE object.
• purify(original_data: list): Converts a list of raw data into a list of DATATUPLE objects.

Concrete Fetchers:

• TWSEFetcher: Used for stocks listed on the Taiwan Stock Exchange (上市).
• TPEXFetcher: Used for stocks listed on the Taipei Exchange (上櫃).

While the codes module provides the underlying logic for querying Taiwan stock codes, end-users typically interact with the pre-parsed data collections provided by the top-level package. You can access stock code information through the following attributes:

• twstock.twse: Access Taiwan Stock Exchange (上市) stock codes.
• twstock.tpex: Access Taipei Exchange (上櫃) stock codes.
• twstock.codes: Access general Taiwan stock codes.

Each entry in these collections provides information structured as a StockCodeInfo object.

If you are using twstock for the first time, you may need to update the TPEX/TWSE stock codes to ensure accuracy.

You can update them via the CLI or within a Python script.

# Via CLI
$ twstock -U

# Via Python
import twstock
twstock.__update_codes()

If you have cloned the source code and wish to install it manually, you must use flit.

First, install flit via pip, then use it to install twstock from within the project directory:

$ pip install flit
$ flit install

When using twstock for the first time, you may need to update the stock lists for the Taiwan Stock Exchange (TWSE) and Taipei Exchange (TPEX). You can do this via the CLI or within a Python script.

Via CLI:

twstock -U

Via Python:

import twstock
twstock.__update_codes()

You can obtain the source code by cloning the repository from GitHub:

$ git clone https://github.com/mlouielu/twstock
$ cd twstock

You can install twstock via PyPI, or by installing from the source code.

Via PyPI:

python -m pip install --user twstock

Via Source (Editable mode):

git clone https://github.com/mlouielu/twstock
cd twstock
python -m pip install -e .

Via Source (Standard install using flit):

git clone https://github.com/mlouielu/twstock
cd twstock
python -m pip install --user flit
flit install

The fastest way to install twstock is using pip. Ensure you are using Python 3 or higher, as Python 2 is not supported.

To install for the current user:

$ pip install --user twstock

To install globally for all users (requires administrative privileges):

$ sudo pip install twstock

The twstock package provides tools for accessing Taiwan stock market data, including real-time data, stock analytics, and CLI tools. The following modules are available for import:

• twstock.stock: Core stock data functionality.
• twstock.analytics: Tools for analyzing stock trends and patterns.
• twstock.realtime: Real-time data access.
• twstock.cli: Command-line interface tools.
• twstock.mock: Mock data for testing.
• twstock.codes: Stock code management and updates.