Obsidiantools 使用教程

Obsidiantools 使用教程

obsidiantools Obsidian tools - a Python package for analysing an Obsidian.md vault 项目地址: https://gitcode.com/gh_mirrors/ob/obsidiantools

1. 项目目录结构及介绍

obsidiantools 是一个用于分析和处理 Obsidian.md 笔记库的 Python 包。以下是项目的目录结构及文件介绍：

obsidiantools/
├── .github/               # 存放 GitHub 工作流文件
│   └── workflows/
├── obsidiantools/         # 包含主要的 Python 模块和代码
│   ├── __init__.py
│   ├── vault.py           # 主要逻辑实现
│   ├── graph.py           # 图结构相关
│   ├── io.py              # 输入输出处理
│   └── utils.py           # 实用工具函数
├── tests/                 # 测试代码和示例数据
│   └── vault-stub/
├── .gitignore             # 指定 Git 忽略的文件
├── LICENSE                # 项目许可证文件
├── README.md              # 项目说明文件
├── codecov.yml            # CodeCov 配置文件
├── requirements.txt       # 项目依赖的 Python 包
├── requirements_test.txt  # 测试所需的 Python 包
└── setup.py               # Python 包的设置文件

2. 项目的启动文件介绍

obsidiantools 的启动主要是通过 Python 的包管理工具 pip 进行安装。安装后，可以直接在 Python 环境中导入 obsidiantools 包使用。以下是启动文件的相关操作：

• 安装 obsidiantools：

  pip install obsidiantools
  

• 在 Python 中导入并使用：

  import obsidiantools as otools
  
  vault = otools.Vault('<VAULT_DIRECTORY>').connect().gather()
  

  其中 <VAULT_DIRECTORY> 是你的 Obsidian 笔记库所在的文件夹路径。

3. 项目的配置文件介绍

项目的配置主要通过 setup.py 文件进行。以下是 setup.py 文件的主要内容：

from setuptools import setup, find_packages

setup(
    name='obsidiantools',
    version='0.10.0',
    packages=find_packages(),
    install_requires=[
        'markdown',
        'pymdown-extensions',
        'html2text',
        'pandas',
        'numpy',
        'networkx',
        'python-frontmatter',
        'beautifulsoup4',
        'lxml',
        'bleach'
    ],
    license='Modified BSD (3-clause)',
    description='A Python package for analysing an Obsidian.md vault',
    author='MFarragher',
    author_email='...",
    url='https://github.com/mfarragher/obsidiantools',
    keywords=[
        'python',
        'data-science',
        'note-taking',
        'network-analysis',
        'knowledge-management',
        'obsidian-md',
        'obsidian-community'
    ]
)

该文件定义了项目的名称、版本、包含的包、依赖项、许可证、描述、作者、作者邮箱、项目主页、关键词等。这些信息对于用户在使用 pip 安装 obsidiantools 时非常重要。

obsidiantools Obsidian tools - a Python package for analysing an Obsidian.md vault 项目地址: https://gitcode.com/gh_mirrors/ob/obsidiantools