开源项目 `fingerprints` 使用教程

开源项目 fingerprints 使用教程

fingerprints Make it easier to compare and cross-reference the names of companies and people by applying strong normalisation. 项目地址: https://gitcode.com/gh_mirrors/fi/fingerprints

1. 项目目录结构及介绍

fingerprints/
├── fingerprints/
│   ├── __init__.py
│   ├── generate.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_generate.py
│   └── ...
├── tools/
│   ├── __init__.py
│   └── ...
├── bumpversion.cfg
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
├── setup.cfg
├── setup.py
└── ...

目录结构说明

• fingerprints/: 项目的主代码目录，包含核心功能实现。

  • __init__.py: 模块初始化文件。
  • generate.py: 生成指纹的核心功能实现。
  • 其他文件和子目录：包含项目的其他功能模块。

• tests/: 测试代码目录，包含项目的单元测试和集成测试。

  • __init__.py: 测试模块初始化文件。
  • test_generate.py: 针对 generate.py 的单元测试。
  • 其他文件和子目录：包含其他测试用例。

• tools/: 工具目录，可能包含一些辅助工具或脚本。

  • __init__.py: 工具模块初始化文件。
  • 其他文件和子目录：包含其他工具或脚本。

• bumpversion.cfg: 版本管理配置文件。

• .gitignore: Git 忽略文件配置。

• LICENSE: 项目许可证文件。

• MANIFEST.in: 打包清单文件。

• Makefile: 项目构建文件。

• README.md: 项目说明文档。

• setup.cfg: 项目配置文件。

• setup.py: 项目安装脚本。

2. 项目启动文件介绍

项目的主要启动文件是 setup.py，它负责项目的安装和配置。通过运行以下命令可以安装项目：

python setup.py install

安装完成后，可以通过导入 fingerprints 模块来使用项目中的功能。例如：

import fingerprints

fp = fingerprints.generate('Mr Sherlock Holmes')
print(fp)  # 输出: 'holmes sherlock'

3. 项目的配置文件介绍

项目的配置文件主要包括 setup.cfg 和 bumpversion.cfg。

setup.cfg

setup.cfg 是项目的配置文件，用于定义项目的元数据和安装选项。以下是一些常见的配置项：

[metadata]
name = fingerprints
version = 0.1.0
description = Make it easier to compare and cross-reference the names of companies and people by applying strong normalisation
author = Aleph Data
license = MIT

[options]
packages = find:
install_requires =
    numpy
    pandas

bumpversion.cfg

bumpversion.cfg 是版本管理配置文件，用于自动化版本号的更新。以下是一个示例配置：

[bumpversion]
current_version = 0.1.0
commit = True
tag = True

通过运行 bumpversion 命令，可以自动更新版本号并提交更改：

bumpversion patch

这将把版本号从 0.1.0 更新到 0.1.1。

---

以上是 fingerprints 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

fingerprints Make it easier to compare and cross-reference the names of companies and people by applying strong normalisation. 项目地址: https://gitcode.com/gh_mirrors/fi/fingerprints