Tehran-Stocks 项目使用教程

Tehran-Stocks 项目使用教程

tehran-stocks A python package to access tsetmc data 项目地址: https://gitcode.com/gh_mirrors/te/tehran-stocks

1. 项目目录结构及介绍

tehran-stocks/
├── bin/
├── src/
│   └── tehran_stocks/
├── tests/
├── .gitignore
├── .travis.yml
├── LICENSE
├── Pipfile.lock
├── README.md
├── poetry.lock
├── pyproject.toml
├── qrcode.png
└── setup.py

目录结构说明

• bin/: 存放可执行脚本文件。
• src/tehran_stocks/: 项目的主要源代码目录，包含访问TSETMC数据的Python包。
• tests/: 存放项目的测试代码。
• .gitignore: Git忽略文件配置。
• .travis.yml: Travis CI配置文件。
• LICENSE: 项目许可证文件，采用MIT许可证。
• Pipfile.lock: Pipenv依赖锁定文件。
• README.md: 项目说明文档。
• poetry.lock: Poetry依赖锁定文件。
• pyproject.toml: Poetry项目配置文件。
• qrcode.png: 项目相关的二维码图片。
• setup.py: 项目安装脚本。

2. 项目启动文件介绍

项目的启动文件主要位于 src/tehran_stocks/ 目录下。以下是主要文件的介绍：

• init.py: 包的初始化文件，通常包含包的初始化代码。
• main.py: 项目的入口文件，包含主要的业务逻辑和功能实现。
• utils.py: 包含一些工具函数和辅助功能。

3. 项目的配置文件介绍

项目的配置文件主要用于配置数据库连接、日志等设置。以下是主要配置文件的介绍：

• config.yml: 项目的配置文件，通常用于配置数据库连接、日志级别等。

配置文件示例

database:
  database: stocks
  engine: postgresql
  host: localhost
  password: password
  port: 5432
  user: postgres

配置文件说明

• database: 数据库配置项。
  • database: 数据库名称。
  • engine: 数据库引擎，如 postgresql。
  • host: 数据库主机地址。
  • password: 数据库密码。
  • port: 数据库端口。
  • user: 数据库用户名。

通过以上配置文件，可以灵活地配置项目的数据库连接信息，以适应不同的开发和生产环境。

tehran-stocks A python package to access tsetmc data 项目地址: https://gitcode.com/gh_mirrors/te/tehran-stocks