GMatch4py 项目教程

GMatch4py 项目教程

GMatch4py A graph matching library for Python 项目地址: https://gitcode.com/gh_mirrors/gm/GMatch4py

1. 项目目录结构及介绍

GMatch4py 是一个用于图匹配的 Python 库，其目录结构如下：

GMatch4py/
├── gmatch4py/
│   ├── __init__.py
│   ├── algorithms/
│   │   ├── __init__.py
│   │   ├── graph_edit_distance.py
│   │   ├── ...
│   ├── helpers/
│   │   ├── __init__.py
│   │   ├── reader.py
│   │   ├── ...
│   ├── ...
├── test/
│   ├── test_graph_edit_distance.py
│   ├── ...
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── logo2.png
├── requirements.txt
├── setup.py

目录结构介绍

• gmatch4py/: 核心代码目录，包含所有图匹配算法的实现。
  • algorithms/: 包含各种图匹配算法的实现文件。
  • helpers/: 包含辅助函数和工具文件。
• test/: 包含项目的测试文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• logo2.png: 项目 Logo。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装配置文件。

2. 项目启动文件介绍

GMatch4py 项目的启动文件是 setup.py，该文件用于配置项目的安装和依赖管理。

setup.py 文件内容

from setuptools import setup, find_packages

setup(
    name='GMatch4py',
    version='0.1',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'cython',
        'networkx'
    ],
    author='Jacques Fize',
    author_email='jacques.fize@cirad.fr',
    description='A graph matching library for Python',
    license='MIT',
    keywords='graph matching networkx cython',
    url='https://github.com/jacquesfize/GMatch4py',
)

启动文件介绍

• name: 项目名称。
• version: 项目版本号。
• packages: 自动查找并包含所有 Python 包。
• install_requires: 项目依赖的 Python 包。
• author: 项目作者。
• author_email: 作者邮箱。
• description: 项目描述。
• license: 项目许可证。
• keywords: 项目关键词。
• url: 项目 GitHub 仓库地址。

3. 项目配置文件介绍

GMatch4py 项目的配置文件主要包括 requirements.txt 和 .travis.yml。

requirements.txt 文件内容

numpy
cython
networkx

配置文件介绍

• requirements.txt: 列出了项目运行所需的 Python 包，用户可以通过 pip install -r requirements.txt 安装所有依赖。
• .travis.yml: Travis CI 配置文件，用于自动化测试和持续集成。

.travis.yml 文件内容

language: python
python:
  - "3.6"
  - "3.7"
  - "3.8"
install:
  - pip install -r requirements.txt
script:
  - pytest

配置文件介绍

• language: 指定项目使用的编程语言。
• python: 指定测试使用的 Python 版本。
• install: 安装项目依赖。
• script: 运行测试脚本。

通过以上配置文件，用户可以方便地安装项目依赖并进行自动化测试。

GMatch4py A graph matching library for Python 项目地址: https://gitcode.com/gh_mirrors/gm/GMatch4py