Metadata-Version: 2.1
Name: aklite
Version: 0.0.3
Summary: AKLite is lite version fo AKShare
Project-URL: Homepage, https://github.com/jindaxiang/aklite
Project-URL: Documentation, https://aklite.readthedocs.io
Author-email: Albert King <albertandking@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
Classifier: Framework :: FastAPI
Classifier: Framework :: Pydantic
Classifier: Framework :: Pydantic :: 1
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.8
Requires-Dist: pandas<3,>=2.0.0
Requires-Dist: requests<3,>=2.31.0
Provides-Extra: all
Requires-Dist: httpx<1,>=0.24.1; extra == 'all'
Requires-Dist: pandas<3,>=2.0.0; extra == 'all'
Provides-Extra: dev
Requires-Dist: pre-commit<3.0.0,>=2.17.0; extra == 'dev'
Requires-Dist: ruff==0.0.138; extra == 'dev'
Requires-Dist: uvicorn[standard]<0.21.0,>=0.12.0; extra == 'dev'
Provides-Extra: doc
Requires-Dist: mdx-include<2.0.0,>=1.4.1; extra == 'doc'
Requires-Dist: mkdocs-markdownextradata-plugin<0.3.0,>=0.1.7; extra == 'doc'
Requires-Dist: mkdocs-material<9.0.0,>=8.1.4; extra == 'doc'
Requires-Dist: mkdocs<2.0.0,>=1.1.2; extra == 'doc'
Requires-Dist: pyyaml<7.0.0,>=5.3.1; extra == 'doc'
Requires-Dist: typer-cli<0.0.14,>=0.0.13; extra == 'doc'
Requires-Dist: typer[all]<0.8.0,>=0.6.1; extra == 'doc'
Provides-Extra: test
Requires-Dist: anyio[trio]<4.0.0,>=3.2.1; extra == 'test'
Requires-Dist: black==23.1.0; extra == 'test'
Requires-Dist: coverage[toml]<8.0,>=6.5.0; extra == 'test'
Requires-Dist: databases[sqlite]<0.7.0,>=0.3.2; extra == 'test'
Requires-Dist: email-validator<2.0.0,>=1.1.1; extra == 'test'
Requires-Dist: flask<3.0.0,>=1.1.2; extra == 'test'
Requires-Dist: httpx<0.24.0,>=0.23.0; extra == 'test'
Requires-Dist: isort<6.0.0,>=5.0.6; extra == 'test'
Requires-Dist: mypy==0.982; extra == 'test'
Requires-Dist: orjson<4.0.0,>=3.2.1; extra == 'test'
Requires-Dist: passlib[bcrypt]<2.0.0,>=1.7.2; extra == 'test'
Requires-Dist: peewee<4.0.0,>=3.13.3; extra == 'test'
Requires-Dist: pytest<8.0.0,>=7.1.3; extra == 'test'
Requires-Dist: python-jose[cryptography]<4.0.0,>=3.3.0; extra == 'test'
Requires-Dist: python-multipart<0.0.7,>=0.0.5; extra == 'test'
Requires-Dist: pyyaml<7.0.0,>=5.3.1; extra == 'test'
Requires-Dist: ruff==0.0.138; extra == 'test'
Requires-Dist: sqlalchemy<1.4.43,>=1.3.18; extra == 'test'
Requires-Dist: types-orjson==3.6.2; extra == 'test'
Requires-Dist: types-ujson==5.7.0.1; extra == 'test'
Requires-Dist: ujson!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,<6.0.0,>=4.0.1; extra == 'test'
Description-Content-Type: text/markdown

## Introduction

AKLite is a lite version of AKShare, which will be used in the future to support the AKShare project.

AKLite Features:
1. Small, fast and powerful
2. High performance
3. Easy to ues

## Installation

```shell
pip install aklite --upgrade -i https://pypi.org/simple
```

## Usage

```python
import aklite as ai

stock_zh_a_hist_obj = ai.stock_zh_a_hist(symbols=["000001", "000002"], period="daily", start_date="20220101", 
                                         end_date="20230601", adjust="hfq", timeout=5, proxies={})
print(stock_zh_a_hist_obj.data)
print(stock_zh_a_hist_obj.columns)
print(stock_zh_a_hist_obj.url)
print(stock_zh_a_hist_obj.desc)
print(stock_zh_a_hist_obj.symbols)
print(stock_zh_a_hist_obj.start_date)
print(stock_zh_a_hist_obj.end_date)
print(stock_zh_a_hist_obj.adjust)
```

```shell
           date  symbol  ...  price_change  turnover_rate
0    2022-01-04  000001  ...         29.26           0.60
1    2022-01-05  000001  ...         79.63           1.01
2    2022-01-06  000001  ...         -4.87           0.57
3    2022-01-07  000001  ...         13.00           0.58
4    2022-01-10  000001  ...         -1.62           0.47
..          ...     ...  ...           ...            ...
677  2023-05-26  000002  ...          2.62           0.42
678  2023-05-29  000002  ...        -23.56           0.46
679  2023-05-30  000002  ...         43.20           0.91
680  2023-05-31  000002  ...        -15.71           0.46
681  2023-06-01  000002  ...        -31.42           0.48
[682 rows x 12 columns]
```

## Contributing

## Translate

```shell
cd docs
sphinx-build -b gettext ./source build/gettext
sphinx-intl update -p ./build/gettext -l zh_CN
```

## Publish

```shell
hatch build
hatch publish
```
