Metadata-Version: 2.4
Name: xs-bundle-cn-stock-os
Version: 0.1.0
Summary: A-share stock market bundle for xscreener (AKShare-based)
Author: poloxue
License: MIT
Project-URL: Homepage, https://github.com/poloxue/xs-bundle-cn-stock-os
Keywords: quantitative,screening,finance,xscreener,a-share,akshare
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: xscreener>=0.1.0
Requires-Dist: pandas>=1.3
Requires-Dist: numpy>=1.21
Requires-Dist: akshare>=1.10

# xs-bundle-cn-stock-os

A-share stock market bundle for the [xscreener](https://github.com/poloxue/xscreener) screening framework. Data sourced from [AKShare](https://akshare.akfamily.xyz/).

## Usage

```python
from xscreener import Screener
from xscreener.databases import MemoryDatabase
from xs_bundle_cn_stock_os import CNStockDataBundle, CNStockFactorGroups

s = Screener(name="My Screener", db=MemoryDatabase())
s.add_data_bundle(CNStockDataBundle)
for g in CNStockFactorGroups:
    s.add_factor_group(g)
s.refresh_all_sources(as_of_date=...)
result = s.screen_latest({"pe": {"op": "GT", "value": 0}})
```
