JoyPy 项目教程

1. 项目目录结构及介绍

JoyPy 项目的目录结构如下：

joypy/
├── data/
│   └── iris.csv
├── joypy/
│   ├── __init__.py
│   ├── joyplot.py
│   └── utils.py
├── tests/
│   ├── test_joyplot.py
│   └── test_utils.py
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── build_and_publish.sh
├── setup.py
└── temperatures.png

目录结构介绍

• data/: 存放示例数据文件，如 iris.csv。
• joypy/: 项目的主要代码目录，包含以下文件：
  • __init__.py: 初始化文件，使 joypy 成为一个 Python 包。
  • joyplot.py: 实现 Joyplot 绘制的主要功能。
  • utils.py: 包含一些辅助函数。
• tests/: 存放测试文件，如 test_joyplot.py 和 test_utils.py。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件，采用 MIT 许可证。
• MANIFEST.in: 包含需要包含在发布包中的文件列表。
• README.md: 项目说明文档。
• build_and_publish.sh: 用于构建和发布项目的脚本。
• setup.py: 项目安装配置文件。
• temperatures.png: 示例输出图像文件。

2. 项目的启动文件介绍

JoyPy 项目没有传统意义上的“启动文件”，因为它是一个库，而不是一个应用程序。用户通过导入 joypy 包并调用其中的函数来使用该库。

例如，用户可以通过以下代码启动 Joyplot 的绘制：

import joypy
import pandas as pd

iris = pd.read_csv("data/iris.csv")
fig, axes = joypy.joyplot(iris)

3. 项目的配置文件介绍

JoyPy 项目的配置文件主要是 setup.py，它用于定义项目的元数据和依赖项，以便于项目的安装和分发。

setup.py 文件内容

from setuptools import setup, find_packages

setup(
    name='joypy',
    version='0.2.6',
    description='Joyplots in Python with matplotlib & pandas',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    author='Leonardo Taccari',
    author_email='[e-mail]',
    url='https://github.com/leotac/joypy',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'scipy>=0.11',
        'matplotlib',
        'pandas>=0.20'
    ],
    classifiers=[
        'Development Status :: 3 - Alpha',
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
        'Topic :: Scientific/Engineering :: Visualization'
    ],
    license='MIT',
    keywords='joyplot ridgeline plot visualization',
    project_urls={
        'Source': 'https://github.com/leotac/joypy',
    },
)

配置文件介绍

• name: 项目名称。
• version: 项目版本号。
• description: 项目简短描述。
• long_description: 项目详细描述，通常从 README.md 文件中读取。
• author: 项目作者。
• url: 项目主页 URL。
• packages: 需要包含的 Python 包，使用 find_packages() 自动查找。
• install_requires: 项目依赖的其他 Python 包。
• classifiers: 项目分类信息，帮助 PyPI 和其他工具识别项目。
• license: 项目许可证。
• keywords: 项目关键词，帮助用户搜索。
• project_urls: 项目相关链接。

通过 setup.py 文件，用户可以使用 pip install . 命令来安装 JoyPy 项目。