Skip to main content

A Python project with MCP tools

Project description

yinzhou-mcp

一个基于MCP的Python项目,提供Bark通知等工具。

项目结构

yinzhou-mcp/
├── src/
│   ├── bark/          # Bark通知模块
│   │   ├── __init__.py
│   │   └── bark.py
│   └── yinzhou-mcp/   # 主模块
│       └── __init__.py
├── pyproject.toml     # 项目配置文件
├── .gitignore         # Git忽略文件
└── README.md          # 项目说明文档

安装要求

  • Python 3.11+
  • uv - 快速Python包管理器

安装教程

1. 安装uv

# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# macOS 和 Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

2. 安装项目

# 从PyPI安装
uv add yinzhou-mcp

# 或从源码安装
uv sync

使用说明

Bark通知模块

配置Bark客户端

from yinzhou-mcp.bark import configure

# 配置Bark客户端
configure("http://yin520.cn:777", "your-device-key")

发送通知

from yinzhou-mcp.bark import send, send_simple, send_with_sound

# 发送普通通知
send("测试标题", "测试内容")

# 发送简单通知
send_simple("简单通知内容")

# 发送带声音的通知
send_with_sound("测试标题", "测试内容", "minuet")

其他通知类型

  • send_continuous_ring: 发送持续响铃的通知
  • send_with_icon: 发送带有自定义图标的通知
  • send_with_group: 发送带有分组名称的通知
  • send_encrypted: 发送加密通知
  • send_critical_alert: 发送带有自定义音量的重要警告
  • send_with_url: 发送带有要打开的URL的通知
  • send_with_image: 发送带有图片的通知
  • send_with_copy: 发送带有要复制到剪贴板的文本的通知

开发

添加依赖

# 添加运行时依赖
uv add package-name

# 添加开发依赖
uv add --dev package-name

运行测试

# 使用uv运行测试
uv run pytest

# 或使用覆盖率
uv run pytest --cov=yinzhou-mcp

代码格式化

# 使用black格式化代码
uv run black src/

# 使用ruff检查代码
uv run ruff check src/

构建和发布

构建项目

# 构建分发包
uv build

发布到PyPI

# 发布到PyPI
uv publish

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request

许可证

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yinzhou_mcp-0.1.0.tar.gz (33.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yinzhou_mcp-0.1.0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file yinzhou_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: yinzhou_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 33.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.0

File hashes

Hashes for yinzhou_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f5df6f6aa75a7e0f5759e0ca5d6d5a5420ca7f0331a93dd38e1c86c745a03f82
MD5 cee1622d6aa4c2870dbb4d4781058fc3
BLAKE2b-256 31791b50f4b6bb689b90407e1e111e39b64d2c64ed23f54b4d6928f9c24a5c7e

See more details on using hashes here.

File details

Details for the file yinzhou_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for yinzhou_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 43e866cf9f3131137e7af7cd92db25dad55ced0189c5ab23f3f8625fa09aaca1
MD5 d0d58c194990269e482619e6d3f03dbd
BLAKE2b-256 d89a8ef6d7b9b3b675f2486f86cfd2424ea7b49f13189e3ec13d6d65b97050d7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page