Skip to content

Commit c1a8a38

Browse files
committed
docs
1 parent be2a4c7 commit c1a8a38

File tree

5 files changed

+50
-36
lines changed

5 files changed

+50
-36
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
9+
## [0.1.3] - 2025-03-16
10+
11+
### Changes
12+
- Entry point for the console script.
13+
14+
### Fixed
15+
- Fix pypi package.
16+
817
## [0.1.2] - 2025-03-16
918

1019
### Added

MANIFEST.in

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,23 @@ flowchart LR
2828

2929
To run the MCP SSE Proxy, execute the `mcp_sse_proxy.py` script with the required `--sse-url` or `ST_PROXY_SSE_URL` environment variable, which specifies the URL of your SSE server endpoint. This is the only required mandatory parameter.
3030

31+
32+
33+
### Installation
34+
35+
```bash
36+
pip3 install mcp-sse-proxy
37+
python3 -m mcp_sse_proxy -h
38+
```
39+
40+
The package installer (pip) creates an executable script in the bin directory of your virtual environment (or Python installation). If you are in a virtual environment, you can run the script using directly as a command.
41+
```bash
42+
mcp-sse-proxy -h
43+
```
3144
### Before you start
32-
If you do installation by copy-past, remember to **Install Dependencies**:
45+
If you do installation by copy-past, remember to install dependencies:
3346
```bash
34-
pip install -r requirements.txt
47+
pip3 install -r requirements.txt
3548
```
3649

3750
## Configuration

setup.py

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,28 @@
1-
from setuptools import setup, find_packages
2-
3-
with open("README.md", "r", encoding="utf-8") as fh:
4-
long_description = fh.read()
1+
from setuptools import setup
52

63
setup(
7-
name="mcp-sse-proxy",
8-
version="0.1.2",
9-
author="Artur Zdolinski",
10-
author_email="contact@nchekwa.com",
11-
description="A proxy for MCP SSE events",
12-
long_description=long_description,
13-
long_description_content_type="text/markdown",
14-
url="https://github.com/getsimpletool/mcp-sse-proxy",
15-
project_urls={
16-
"Bug Tracker": "https://github.com/getsimpletool/mcp-sse-proxy/issues",
17-
},
18-
classifiers=[
19-
"Programming Language :: Python :: 3",
20-
"License :: OSI Approved :: MIT License",
21-
"Operating System :: OS Independent",
22-
],
23-
package_dir={"": "src"},
24-
packages=find_packages(where="src"),
25-
python_requires=">=3.7",
4+
name='mcp-sse-proxy',
5+
version='0.1.3',
6+
description='Proxy between MCP server using STDIO transport and client using SSE transport',
7+
author='Artur Zdolinski',
8+
author_email='artur@zdolinski.com',
9+
url='https://github.com/getsimpletool/mcp-sse-proxy',
10+
py_modules=['mcp_sse_proxy'],
11+
package_dir={'': 'src'},
2612
install_requires=[
27-
"httpx>=0.24.0",
28-
"anyio>=4.7.0",
29-
"python-dotenv"
13+
'httpx>=0.24.0',
14+
'anyio>=4.7.0',
15+
'python-dotenv',
3016
],
3117
entry_points={
32-
"console_scripts": [
33-
"mcp-sse-proxy=mcp_sse_proxy:main",
18+
'console_scripts': [
19+
'mcp-sse-proxy=mcp_sse_proxy:main',
3420
],
3521
},
22+
classifiers=[
23+
'Programming Language :: Python :: 3',
24+
'License :: OSI Approved :: MIT License',
25+
'Operating System :: OS Independent',
26+
],
27+
python_requires='>=3.10',
3628
)

src/mcp_sse_proxy.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,11 @@ async def ping_checker(ping_interval: int):
326326
tg.start_soon(ping_checker, ping_interval)
327327

328328

329-
if __name__ == "__main__":
329+
def main():
330+
"""Entry point for the console script."""
330331
proxy = Proxy()
331332
asyncio.run(proxy.main())
333+
334+
335+
if __name__ == "__main__":
336+
main()

0 commit comments

Comments
 (0)