py-money 项目教程

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

py-money/
├── LICENSE
├── README.md
├── setup.py
├── money/
│   ├── __init__.py
│   ├── currency.py
│   ├── money.py
│   └── tests/
│       ├── __init__.py
│       ├── test_currency.py
│       └── test_money.py
└── docs/
    ├── conf.py
    ├── index.rst
    └── Makefile

• LICENSE: 项目的许可证文件。
• README.md: 项目说明文档。
• setup.py: 项目的安装脚本。
• money/: 项目的主要代码目录。
  • init.py: 初始化文件，使目录成为一个包。
  • currency.py: 货币相关的类和函数。
  • money.py: 主要的钱类和相关操作。
  • tests/: 测试代码目录。
    • init.py: 初始化文件，使目录成为一个包。
    • test_currency.py: 货币相关的测试代码。
    • test_money.py: 钱类相关的测试代码。
• docs/: 项目文档目录。
  • conf.py: 文档配置文件。
  • index.rst: 文档主页。
  • Makefile: 文档构建脚本。

2. 项目的启动文件介绍

项目的启动文件是 setup.py。这个文件用于安装和管理项目的依赖，以及打包和分发项目。通过运行以下命令可以安装项目：

pip install .

3. 项目的配置文件介绍

项目的配置文件主要有两个：

• setup.py: 用于配置项目的安装和打包信息。
• docs/conf.py: 用于配置项目的文档生成信息。

setup.py

setup.py 文件包含了项目的元数据和依赖信息，例如：

from setuptools import setup, find_packages

setup(
    name='py-money',
    version='0.5.0',
    packages=find_packages(),
    install_requires=[],
    author='J C Manzo',
    author_email='[e-mail]',
    description='Money module for Python',
    license='MIT',
    keywords='money currency',
    url='https://github.com/vimeo/py-money',
)

docs/conf.py

docs/conf.py 文件用于配置 Sphinx 文档生成工具的参数，例如：

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

project = 'py-money'
copyright = '2020, J C Manzo'
author = 'J C Manzo'

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.viewcode',
    'sphinx.ext.napoleon'
]

templates_path = ['_templates']

exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

html_theme = 'alabaster'

html_static_path = ['_static']

通过这些配置文件，可以方便地管理和生成项目的文档和安装包。