semvec/pypi-packages huggingface dataset:
cmdpedia-generator 0.0.1a2
A tool for generating command documentation from Python CLI applications.
Requires Python: >=3.6

# > cmdpedia

cmdpedia is a work-in-progress that aims to make documenting command line applications easier.

Given a Python (Click-only for now) module, it'll parse its docstring and commands to generate a single HTML file that displays this information in a searchable, interactive way.

## Features

- Standalone, sharable HTML file
- Search for commands by name or keyword
- View available inputs for a selected command
- Add inputs to customize the command's syntax
- Edit placeholder values in the syntax
- Copy the complete command syntax with selected inputs

## Demo

[View the cmdpedia for this project's main module.](https://derekology.github.io/cmdpedia/)

Additional examples are located in the [docs/example_modules](https://github.com/derekology/cmdpedia/tree/main/docs/example_modules) folder.

## Installation

Install the generator from [PyPi](https://pypi.org/project/cmdpedia-generator/) by executing `pip install cmdpedia_generator`

## Usage

Once installed, generate a cmdpedia by either importing the module and calling the `generate()` function with the program type and filepath passed as arguments, or by running the package as a script.

Usage examples can be found in the [docs/example_modules](https://github.com/derekology/cmdpedia/tree/main/docs/example_modules) folder.

## Contributing

Contributions are welcome! If you find a bug or have an idea for an enhancement, feel free to open an issue or submit a pull request.

## Contact

If you have any questions about this project, please feel free to reach out to me at me@derekw.co.
nonebot-plugin-liteyukibot 0.1.9
nonebot-plugin-liteyukibot
Requires Python: <4.0,>=3.10

<div align="center">
  <img src="https://cdn.liteyuki.icu/static/img/liteyuki_icon_640.png" width="180" height="180" alt="NoneBotPluginLogo">

</div>

<div align="center">

# nonebot-plugin-liteyukibot

_✨ 在NoneBot中使用轻雪及轻雪插件 ✨_


<a href="./LICENSE">
    <img src="https://img.shields.io/github/license/LiteyukiStudio/nonebot-plugin-liteyukibot.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-liteyukibot">
    <img src="https://img.shields.io/pypi/v/nonebot-plugin-liteyukibot.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">

</div>

## 📖 介绍

在NoneBot机器人中使用[轻雪机器人](https://bot.liteyuki.icu)的功能！

## 💿 安装

<details open>
<summary>使用 nb-cli 安装(推荐，需先安装`nb-cli`)</summary>
在 轻雪 项目的根目录下打开命令行, 输入以下指令即可安装

    nb plugin install nonebot-plugin-liteyukibot

</details>

<details open>
<summary>使用 pip 安装</summary>
在 轻雪 项目的根目录下打开命令行, 输入以下指令即可安装

    pip install nonebot-plugin-liteyukibot

</details>

<details>
<summary>使用包管理器安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

<details>
<summary>pip</summary>

    pip install nonebot-plugin-liteyukibot

</details>
<details>
<summary>pdm</summary>

    pdm add nonebot-plugin-liteyukibot

</details>
<details>
<summary>poetry</summary>

    poetry add nonebot-plugin-liteyukibot

</details>
<details>
<summary>conda</summary>

    conda install nonebot-plugin-liteyukibot

</details>
</details>

## 🎉 使用

- 使用`nb-cli`安装的插件默认加载，无需额外配置
- 包管理器手动安装需在`pyproject.toml`中添加如下配置
- 详细用法请访问[轻雪主页](https://bot.liteyuki.icu)

```toml
plugins = ["nonebot_plugin_liteyukibot"]
```

## ⚙️ 配置

在插件运行模式下无需配置太多内容，如果需要配置，请 参考LiteyukiBot的[配置文档](https://bot.liteyuki.icu/deploy/config.html)，
在config下新建配置文件`nonebot.yml/toml/json`(你可自行命名)，填入如下结构配置文件，这里使用yaml

## ℹ️ 其他

- 目前该插件已内置在[轻雪机器人应用](https://bot.liteyuki.icu)中，无需单独安装

- 如果你是基于[轻雪框架](https://pypi.org/project/liteyukibot/)二次开发，需要手动安装

- 该插件仍然有许多内容需要完善，欢迎各位的建议及贡献

- ⚠ 警告：请勿在轻雪机器人中安装`liteyukibot-plugin-nonebot`后在NoneBot中安装`nonebot-plugin-liteyukibot`，否则会导致循环加载和冲突