pyAudioProcessing 项目使用教程

1. 项目目录结构及介绍

pyAudioProcessing 项目的目录结构如下：

pyAudioProcessing/
├── data_samples/
├── pyAudioProcessing/
├── requirements/
│   └── requirements.txt
├── tests/
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE.md
├── README.md
├── setup.cfg
└── setup.py

目录结构介绍

• data_samples/: 存放示例音频数据的目录。
• pyAudioProcessing/: 项目的主要代码目录，包含音频处理和特征提取的实现。
• requirements/: 存放项目依赖文件的目录，包含 requirements.txt 文件。
• tests/: 存放测试代码的目录。
• .gitignore: Git 忽略文件配置。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• LICENSE.md: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• setup.cfg: 项目的配置文件。
• setup.py: 项目的安装脚本。

2. 项目的启动文件介绍

pyAudioProcessing 项目没有明确的“启动文件”，因为它是一个库，而不是一个独立的应用程序。用户可以通过导入 pyAudioProcessing 模块来使用其中的功能。

例如：

from pyAudioProcessing import feature_extraction

# 使用 feature_extraction 模块中的功能
features = feature_extraction.extract_features("path/to/audio.wav")

3. 项目的配置文件介绍

setup.cfg

setup.cfg 是项目的配置文件，用于配置 setuptools 的安装过程。它通常包含以下内容：

[metadata]
name = pyAudioProcessing
version = 1.1.13
description = A Python based library for processing audio data into features (GFCC, MFCC, spectral, chroma) and building Machine Learning models.
long_description = file: README.md
long_description_content_type = text/markdown
author = Jyotika Singh
author_email = [e-mail]
url = https://github.com/jsingh811/pyAudioProcessing
license = GPL-3.0

[options]
packages = find:
install_requires =
    numpy
    scipy
    scikit-learn
    librosa

[options.packages.find]
where = .

setup.py

setup.py 是项目的安装脚本，用于定义项目的元数据和依赖项。它通常包含以下内容：

from setuptools import setup, find_packages

setup(
    name="pyAudioProcessing",
    version="1.1.13",
    description="A Python based library for processing audio data into features (GFCC, MFCC, spectral, chroma) and building Machine Learning models.",
    long_description=open("README.md").read(),
    long_description_content_type="text/markdown",
    author="Jyotika Singh",
    author_email="[e-mail]",
    url="https://github.com/jsingh811/pyAudioProcessing",
    license="GPL-3.0",
    packages=find_packages(),
    install_requires=[
        "numpy",
        "scipy",
        "scikit-learn",
        "librosa"
    ],
    classifiers=[
        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
    ],
)

setup.py 文件定义了项目的名称、版本、描述、作者、依赖项等信息，并指定了项目的包和分类器。

通过以上配置文件，用户可以轻松地安装和使用 pyAudioProcessing 项目。