Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lipraty/nonebot-plugin-ghtiles


https://github.com/lipraty/nonebot-plugin-ghtiles

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        



logo




logo


# NoneBot-Plugin-GHTiles

_✨ 看看你的 GitHub 瓷砖 for NoneBot2 ✨_

python

pdm-managed



Pydantic Version 1 Or 2


license


pypi


pypi download

## 📖 介绍

NoneBot2 插件,用于查看你的 GitHub 瓷砖

## 💿 安装

以下提到的方法 任选**其一** 即可

[推荐] 使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

```bash
nb plugin install nonebot-plugin-ghtiles
```

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

pip

```bash
pip install nonebot-plugin-ghtiles
```

pdm

```bash
pdm add nonebot-plugin-ghtiles
```

poetry

```bash
poetry add nonebot-plugin-ghtiles
```

conda

```bash
conda install nonebot-plugin-ghtiles
```

打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分的 `plugins` 项里追加写入

```toml
[tool.nonebot]
plugins = [
# ...
"nonebot_plugin_ghtiles"
]
```

## ⚙️ 配置

#### `ght_proxy`

- **类型**: `str`
- **默认值**: `"https://github.com"`

GitHub 地址,如果需要解决国内访问 GitHub 的问题,可以替换为镜像站点

## 🎉 使用

### 指令

#### `tile`

查看你的 GitHub 瓷砖

#### `tile.bind `

绑定你的 GitHub 用户名

#### `tile.remind`

创建一个提醒,当这一天即将过去而你还没有提交时,会提醒你

## 💡 鸣谢

### [nonebot/plugin-alconna](https://github.com/nonebot/plugin-alconna)

- 强大的命令解析库,和多平台适配方案