mftool 项目使用教程

mftool 项目使用教程

mftool ⚡ Python library for getting real-time Mutual Funds data in India 项目地址: https://gitcode.com/gh_mirrors/mf/mftool

1. 项目的目录结构及介绍

mftool 项目的目录结构如下：

mftool/
├── data/
├── docs/
├── tests/
├── github/workflows/
├── .gitignore
├── readthedocs.yaml
├── LICENSE
├── README.md
├── __init__.py
├── const.json
├── mftool.py
├── requirements.txt
├── setup.py
└── utils.py

目录结构介绍

• data/: 存放项目所需的数据文件。
• docs/: 存放项目的文档文件。
• tests/: 存放项目的测试文件。
• github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• .gitignore: Git 忽略文件配置。
• readthedocs.yaml: Read the Docs 配置文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• init.py: Python 包的初始化文件。
• const.json: 项目中使用的常量配置文件。
• mftool.py: 项目的主要功能实现文件。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目的安装配置文件。
• utils.py: 项目中使用的工具函数文件。

2. 项目的启动文件介绍

mftool 项目的主要启动文件是 mftool.py。该文件包含了获取实时 Mutual Funds 数据的主要功能实现。

主要功能

• 获取最新报价: 通过 Scheme 代码获取 Mutual Fund 的最新报价。
• 获取所有 Scheme 的报价: 获取所有在 AMFI 注册的 Mutual Fund Scheme 的报价。
• 检查 Scheme 代码: 检查给定的 Scheme 代码是否有效。
• 获取历史 NAV: 获取某个 Scheme 的历史 NAV 数据。
• 获取所有 Scheme 列表: 获取所有 Mutual Fund Scheme 的列表及其 Scheme 代码。
• 获取每日 Scheme 表现: 获取某个 Scheme 的每日表现数据。

3. 项目的配置文件介绍

mftool 项目的主要配置文件是 const.json。该文件包含了项目中使用的常量配置。

配置文件内容

{
  "AMFI_URL": "https://www.amfiindia.com/spages/NAVAll.txt",
  "HISTORICAL_NAV_URL": "https://www.amfiindia.com/spages/NAVOpen.txt",
  "SCHEME_CODE_URL": "https://www.amfiindia.com/spages/NAVOpen.txt"
}

配置项介绍

• AMFI_URL: 获取所有 Mutual Fund Scheme 报价的 URL。
• HISTORICAL_NAV_URL: 获取历史 NAV 数据的 URL。
• SCHEME_CODE_URL: 获取所有 Scheme 代码的 URL。

通过这些配置项，mftool 能够从 AMFI 获取所需的 Mutual Funds 数据。

mftool ⚡ Python library for getting real-time Mutual Funds data in India 项目地址: https://gitcode.com/gh_mirrors/mf/mftool