Skip to content

Commit 965fc2e

Browse files
committed
Add PyPI badges, fix license format, add release process
1 parent ec9d08c commit 965fc2e

3 files changed

Lines changed: 74 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# click-mcp
22

3+
[![PyPI version](https://badge.fury.io/py/click-mcp.svg)](https://badge.fury.io/py/click-mcp)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
36
A Python library that extends Click applications with Model Context Protocol (MCP) support, allowing AI agents to interact with CLI tools.
47

58
## Overview

RELEASE_PROCESS.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Release Process for click-mcp
2+
3+
This document outlines the steps to release a new version of click-mcp.
4+
5+
## 1. Update Version Number
6+
7+
1. Edit `pyproject.toml` and update the version number:
8+
9+
```toml
10+
[project]
11+
name = "click-mcp"
12+
version = "X.Y.Z" # Update this line
13+
```
14+
15+
2. Commit the change:
16+
17+
```bash
18+
git add pyproject.toml
19+
git commit -m "Bump version to X.Y.Z"
20+
```
21+
22+
## 2. Create a GitHub Release
23+
24+
1. Push your changes to GitHub:
25+
26+
```bash
27+
git push origin main
28+
```
29+
30+
2. Go to the GitHub repository: https://github.com/crowecawcaw/click-mcp
31+
32+
3. Click on "Releases" in the right sidebar
33+
34+
4. Click "Create a new release"
35+
36+
5. Enter the following information:
37+
- Tag version: `vX.Y.Z` (e.g., `v0.1.1`)
38+
- Release title: `Version X.Y.Z`
39+
- Description: Add release notes describing the changes in this version
40+
41+
6. Click "Publish release"
42+
43+
## 3. Automatic PyPI Publishing
44+
45+
The GitHub Actions workflow will automatically:
46+
1. Build the package
47+
2. Upload it to PyPI
48+
3. Make it available for installation via `pip install click-mcp`
49+
50+
## 4. Verify the Release
51+
52+
After the GitHub Actions workflow completes:
53+
54+
1. Check that the package is available on PyPI: https://pypi.org/project/click-mcp/
55+
56+
2. Test installation in a clean environment:
57+
58+
```bash
59+
pip install click-mcp==X.Y.Z
60+
```
61+
62+
## Version Numbering Guidelines
63+
64+
Follow semantic versioning (SemVer):
65+
66+
- **MAJOR** version (X): Incompatible API changes
67+
- **MINOR** version (Y): Add functionality in a backward-compatible manner
68+
- **PATCH** version (Z): Backward-compatible bug fixes
69+
70+
For pre-releases, use suffixes like `-alpha.1`, `-beta.1`, etc.

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,10 @@ authors = [
1111
{name = "Stephen Crowe"}
1212
]
1313
requires-python = ">=3.8"
14-
license = {text = "MIT"}
14+
license = "MIT"
1515
classifiers = [
1616
"Development Status :: 4 - Beta",
1717
"Intended Audience :: Developers",
18-
"License :: OSI Approved :: MIT License",
1918
"Programming Language :: Python :: 3",
2019
"Programming Language :: Python :: 3.8",
2120
"Programming Language :: Python :: 3.9",

0 commit comments

Comments
 (0)