开源财经数据接口库-aktools

评论
36 views

这个仓库名为 aktools，是一款用于快速搭建 AKShare HTTP API 的工具，通过它可以利用一行命令来启动 HTTP 服务，从而让原本专属服务于 Python 用户的开源财经数据接口库 AKShare 的使用突破编程语言的限制。以下是该仓库的详细介绍：

主要特点

  • 依赖于 AKShare、FastAPI 和 Typer。
  • 无论使用 C/C++、Java、Go、Rust、Ruby、PHP、JavaScript、R、Matlab、Stata 等编程语言或软件，都可以快速、轻松获取财经数据，助力更好地展开研究和开发工作。

目录结构

.gitignore
.pre-commit-config.yaml
.readthedocs.yaml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile
LICENSE
README.md
alembic.ini
mkdocs.yml
pyproject.toml
requirements-dev.txt
requirements.txt
setup.py
aktools/
 __init__.py
 __main__.py
 api_debug/
 assets/
 cli.py
 config.py
 core/
 database/
 datasets.py
 login/
 main.py
 model/
 schema/
 utils.py
tests/
 __init__.py
 test_cli.py
 test_demo.py
docs/
 aktools.md
 aktools_version.md
 css/
 index.md
 js/
 requirements.txt
alembic/
 ...
.github/
 ...

主要文件和文件夹说明

  • 根目录文件：
  • Dockerfile：用于构建 Docker 镜像的文件。
  • LICENSE：项目的许可证文件，本项目采用 MIT 许可证。
  • README.md：项目的说明文档，包含项目的基本信息、安装方法、使用示例等。
  • requirements.txt：项目的依赖库列表文件。
  • setup.py：用于打包和分发 Python 项目的文件。
  • aktools 文件夹：项目的主要源代码文件夹。
  • config.py：配置文件，包含数据库配置、授权配置等相关信息。
  • main.py：项目的主程序文件。
  • utils.py：工具函数文件，包含一些常用的工具函数。
  • login：登录相关的代码文件。
  • database：数据库相关的代码文件。
  • model：模型相关的代码文件。
  • schema：数据模式相关的代码文件。
  • tests 文件夹：测试代码文件夹，包含项目的单元测试和集成测试代码。
  • docs 文件夹：项目的文档文件夹，包含项目的说明文档、API 文档等。

安装与升级

  • 安装： shell pip install aktools
  • 升级： shell pip install aktools --upgrade -i https://pypi.org/simple # AKTools's version should great than 0.0.70

快速运行

  1. 输入命令：python -m aktools。
  2. 在 Chrome 浏览器中输入 http://127.0.0.1:8080/ ，可以访问项目的主页获取更多信息。
  3. 如果只想测试数据 API，可以在 Chrome 浏览器中输入 http://127.0.0.1:8080/api/public/stock_zh_a_hist。
  4. 如果想为 API 设置参数，可以输入类似 http://127.0.0.1:8080/api/public/stock_zh_a_hist?symbol=600000 的地址。

文档链接