首页
/ 开源项目 yq 使用教程

开源项目 yq 使用教程

2024-08-10 07:44:31作者:裴麒琰

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

yq/
├── CHANGELOG.rst
├── CONTRIBUTING.rst
├── Dockerfile
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.rst
├── setup.cfg
├── setup.py
├── tests/
│   ├── __init__.py
│   ├── test_cli.py
│   ├── test_data/
│   │   ├── example.yaml
│   │   └── example.yml
│   └── test_yq.py
└── yq/
    ├── __init__.py
    ├── cli.py
    └── yq.py
  • CHANGELOG.rst: 项目更新日志。
  • CONTRIBUTING.rst: 贡献指南。
  • Dockerfile: 用于构建 Docker 镜像。
  • LICENSE: 项目许可证。
  • MANIFEST.in: 打包清单文件。
  • Makefile: 用于自动化构建和测试。
  • README.rst: 项目说明文档。
  • setup.cfg: 安装配置文件。
  • setup.py: 安装脚本。
  • tests/: 测试目录,包含测试脚本和测试数据。
  • yq/: 项目源码目录,包含主要功能实现。

2. 项目的启动文件介绍

项目的启动文件是 yq/cli.py。这个文件定义了命令行接口,处理用户输入并调用相应的功能模块。

# yq/cli.py
import argparse
import sys
from .yq import process

def main():
    parser = argparse.ArgumentParser(description='Process some YAML files.')
    parser.add_argument('expression', help='Expression to apply to each document')
    parser.add_argument('files', nargs='+', help='YAML files to process')
    args = parser.parse_args()

    for file in args.files:
        with open(file) as f:
            process(f, args.expression)

if __name__ == '__main__':
    main()

3. 项目的配置文件介绍

项目的配置文件主要是 setup.cfgsetup.py

  • setup.cfg: 包含项目的基本配置信息,如包名、版本号、作者等。
[metadata]
name = yq
version = 2.12.2
description = Command-line YAML processor - jq for YAML documents
long_description = file: README.rst
author = Andrey Kislyuk
author_email = kislyuk@gmail.com
url = https://github.com/kislyuk/yq
license = Apache Software License
classifiers =
    Development Status :: 5 - Production/Stable
    Intended Audience :: Developers
    License :: OSI Approved :: Apache Software License
    Natural Language :: English
    Operating System :: OS Independent
    Programming Language :: Python
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.6
    Programming Language :: Python :: 3.7
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
    Topic :: Software Development :: Libraries :: Python Modules
    Topic :: Text Processing :: Markup :: YAML

[options]
packages = find:
install_requires =
    PyYAML >= 5.1
    argparse
    setuptools

[options.entry_points]
console_scripts =
    yq = yq.cli:main
  • setup.py: 用于安装和打包项目的脚本。
# setup.py
from setuptools import setup, find_packages

setup(
    name='yq',
    version='2.12.2',
    description='Command-line YAML processor - jq for YAML documents',
    long_description=open('README.rst').read(),
    author='Andrey Kislyuk',
    author_email='kislyuk@gmail.com',
    url='https://github.com/kislyuk/yq',
    license='Apache Software License',
    packages=find_packages(exclude=['test']),
    install_requires=[
        'PyYAML >= 5.1',
        'argparse'
    ],
    entry_points={
        'console_scripts':
登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511