# Python Wisp Server
This is an implementation of a [Wisp](https://github.com/MercuryWorkshop/wisp-protocol) server, written in Python. It follows the Wisp v1 spec completely, including support for UDP connections.
## Installation:
### Install From Source:
Clone this repository and cd into it, then run the following commands:
```
python3 -m venv .venv
source .venv/bin/activate
pip3 install -e .
```
### Install From PyPI:
Run the following command to install this program:
```
pip3 install wisp-python
```
## Running the Server:
To start the server, run `python3 -m wisp.server`. The program accepts the following arguments:
```
usage: wisp-server-python [-h] [--host HOST] [--port PORT] [--static STATIC] [--limits] [--bandwidth BANDWIDTH] [--connections CONNECTIONS] [--window WINDOW] [--allow-loopback] [--allow-private]
[--log-level LOG_LEVEL]
A Wisp server implementation, written in Python (v0.5.0)
options:
-h, --help show this help message and exit
--host HOST The hostname the server will listen on.
--port PORT The TCP port the server will listen on.
--static STATIC Where static files are served from.
--limits Enable rate limits.
--bandwidth BANDWIDTH
Bandwidth limit per IP, in kilobytes per second.
--connections CONNECTIONS
New connections limit per IP.
--window WINDOW Fixed window length for rate limits, in seconds.
--allow-loopback Allow connections to loopback IP addresses.
--allow-private Allow connections to private IP addresses.
--log-level LOG_LEVEL
The log level (either debug, info, warning, error, or critical).
```
## Roadmap:
- ~~Rate limits~~
- JSON based config files
- ~~UDP support~~
- ~~Ability to block local addresses~~
## Copyright:
This repository is licensed under the GNU AGPL v3.
### Copyright Notice:
```
wisp-server-python: a Wisp server implementation written in Python
Copyright (C) 2024 Mercury Workshop
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "wisp-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "ading2210",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/49/b6/b887b0c8631a5eb110c59ea684952a226201eaedc70740079c8eb905b1c6/wisp_python-0.5.0.tar.gz",
"platform": null,
"description": "# Python Wisp Server\n\nThis is an implementation of a [Wisp](https://github.com/MercuryWorkshop/wisp-protocol) server, written in Python. It follows the Wisp v1 spec completely, including support for UDP connections.\n\n## Installation:\n### Install From Source:\nClone this repository and cd into it, then run the following commands:\n```\npython3 -m venv .venv\nsource .venv/bin/activate\npip3 install -e .\n```\n\n### Install From PyPI:\nRun the following command to install this program:\n```\npip3 install wisp-python\n```\n\n## Running the Server:\nTo start the server, run `python3 -m wisp.server`. The program accepts the following arguments:\n```\nusage: wisp-server-python [-h] [--host HOST] [--port PORT] [--static STATIC] [--limits] [--bandwidth BANDWIDTH] [--connections CONNECTIONS] [--window WINDOW] [--allow-loopback] [--allow-private]\n [--log-level LOG_LEVEL]\n\nA Wisp server implementation, written in Python (v0.5.0)\n\noptions:\n -h, --help show this help message and exit\n --host HOST The hostname the server will listen on.\n --port PORT The TCP port the server will listen on.\n --static STATIC Where static files are served from.\n --limits Enable rate limits.\n --bandwidth BANDWIDTH\n Bandwidth limit per IP, in kilobytes per second.\n --connections CONNECTIONS\n New connections limit per IP.\n --window WINDOW Fixed window length for rate limits, in seconds.\n --allow-loopback Allow connections to loopback IP addresses.\n --allow-private Allow connections to private IP addresses.\n --log-level LOG_LEVEL\n The log level (either debug, info, warning, error, or critical).\n```\n\n## Roadmap:\n- ~~Rate limits~~\n- JSON based config files\n- ~~UDP support~~\n- ~~Ability to block local addresses~~\n\n## Copyright:\nThis repository is licensed under the GNU AGPL v3.\n\n### Copyright Notice:\n```\nwisp-server-python: a Wisp server implementation written in Python\nCopyright (C) 2024 Mercury Workshop\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "An implementation of a Wisp proxy server in Python",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/MercuryWorkshop/wisp-server-python",
"Issues": "https://github.com/MercuryWorkshop/wisp-server-python/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ace001807219b0c18f0f1d88a8f7732af5a7f3aa052032a21bf5ae345687bcad",
"md5": "ebc83ac5a07a1828639f45557f449033",
"sha256": "016782dd023a01508c03c207f6dd72269d52ebf7b55648b12d36036dfa48f0c1"
},
"downloads": -1,
"filename": "wisp_python-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ebc83ac5a07a1828639f45557f449033",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20744,
"upload_time": "2024-10-01T23:30:34",
"upload_time_iso_8601": "2024-10-01T23:30:34.725149Z",
"url": "https://files.pythonhosted.org/packages/ac/e0/01807219b0c18f0f1d88a8f7732af5a7f3aa052032a21bf5ae345687bcad/wisp_python-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49b6b887b0c8631a5eb110c59ea684952a226201eaedc70740079c8eb905b1c6",
"md5": "84912cc63d33ce4a16f136997b0af0e6",
"sha256": "a6bb43b283ddeaf44a5ca5ca8ab4d2dcc2184201cae468cccc0e3e5903214649"
},
"downloads": -1,
"filename": "wisp_python-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "84912cc63d33ce4a16f136997b0af0e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 20180,
"upload_time": "2024-10-01T23:30:36",
"upload_time_iso_8601": "2024-10-01T23:30:36.291631Z",
"url": "https://files.pythonhosted.org/packages/49/b6/b887b0c8631a5eb110c59ea684952a226201eaedc70740079c8eb905b1c6/wisp_python-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 23:30:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MercuryWorkshop",
"github_project": "wisp-server-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "websockets",
"specs": []
},
{
"name": "asyncudp",
"specs": []
},
{
"name": "uvloop",
"specs": []
}
],
"lcname": "wisp-python"
}
JSON
