Parser-2GIS 项目使用教程

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

parser-2gis/
├── github/
│   └── workflows/
├── scripts/
├── tests/
├── .gitignore
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── parser-2gis.py
├── setup.cfg
├── setup.py
└── tox.ini

目录结构介绍

• github/workflows/: 包含GitHub Actions的工作流配置文件。
• scripts/: 包含项目的脚本文件。
• tests/: 包含项目的测试文件。
• .gitignore: 指定Git应忽略的文件和目录。
• .pre-commit-config.yaml: 配置pre-commit钩子，用于代码格式化和检查。
• CHANGELOG.md: 记录项目的变更日志。
• LICENSE: 项目的开源许可证文件。
• MANIFEST.in: 指定在打包时需要包含的非Python文件。
• README.md: 项目的介绍和使用说明。
• parser-2gis.py: 项目的主启动文件。
• setup.cfg: 项目的配置文件。
• setup.py: 用于安装项目的脚本。
• tox.ini: 配置tox，用于自动化测试和环境管理。

2. 项目的启动文件介绍

parser-2gis.py

这是项目的主启动文件，负责初始化和运行Parser-2GIS的主要功能。文件中包含了主要的逻辑和功能实现，如数据抓取、处理和输出等。

# parser-2gis.py 文件示例
import sys
from parser_2gis import Parser2GIS

def main():
    parser = Parser2GIS()
    parser.run()

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

setup.cfg

setup.cfg 是项目的配置文件，用于配置项目的安装和打包选项。它包含了项目的元数据、依赖项、测试配置等信息。

# setup.cfg 文件示例
[metadata]
name = parser-2gis
version = 1.2.1
description = Парсер сайта 2GIS для сбора адресов и контактов предприятий
author = Andy Trofimov
license = LGPL-3.0

[options]
packages = find:
install_requires =
    requests
    beautifulsoup4

[options.entry_points]
console_scripts =
    parser-2gis = parser_2gis:main

[tool:pytest]
addopts = --cov=parser_2gis

setup.py

setup.py 是用于安装项目的脚本，通常与 setup.cfg 配合使用。它包含了项目的安装逻辑和依赖项管理。

# setup.py 文件示例
from setuptools import setup, find_packages

setup(
    name='parser-2gis',
    version='1.2.1',
    packages=find_packages(),
    install_requires=[
        'requests',
        'beautifulsoup4',
    ],
    entry_points={
        'console_scripts': [
            'parser-2gis = parser_2gis:main',
        ],
    },
)

通过以上配置文件，可以方便地安装和管理Parser-2GIS项目，并确保其正常运行和测试。