| Name | pywebfs JSON |
| Version |
1.0.10
JSON |
| download |
| home_page | https://github.com/joknarf/pywebfs |
| Summary | Simple Python HTTP File Server |
| upload_time | 2024-12-18 07:44:10 |
| maintainer | Franck Jouvanceau |
| docs_url | None |
| author | Franck Jouvanceau |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2024 joknarf Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
http
fileserver
browser
explorer
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/pywebfs/)
[](https://shields.io/)
[](https://pepy.tech/project/pywebfs)
[](https://shields.io/)
# pywebfs
Simple Python HTTP(S) File Server
## Install
```
$ pip install pywebfs
```
## Quick start
* start http server sharing current directory listening on 0.0.0.0 port 8080
```
$ pywebfs
```
* Browse/Download/Search files using browser `http://<yourserver>:8080`
* search text in files (grep)
## features
* Serve static files
* Download folder as zip file
* Filter files
* Search files recursively multiple word any order (disable feature with --nosearch)
* Search text in files recursively
* Basic Auth support (single user)
* HTTPS support
* HTTPS self-signed certificate generator
* Display owner/group/permissions (POSIX) (disable feature with --noperm)
* Can be started as a daemon (POSIX)
## Customize server
```
$ pywebfs --dir /mydir --title "my fileserver" --listen 0.0.0.0 --port 8080
$ pywebfs -d /mydir -t "my fileserver" -l 0.0.0.0 -p 8080
```
## Basic auth user/password
```
$ pywebfs --dir /mydir --user myuser [--password mypass]
$ pywebfs -d /mydir -u myuser [-P mypass]
```
Generated password is given if no `--pasword` option
## HTTPS server
* Generate auto-signed certificate and start https server
```
$ pywebfs --dir /mydir --gencert
$ pywebfs -d /mydir --g
```
* Start https server using existing certificate
```
$ pywebfs --dir /mydir --cert /pathto/host.cert --key /pathto/host.key
$ pywebfs -d /mydir -c /pathto/host.cert -k /pathto/host.key
```
## Launch server as a daemon (Linux)
```
$ pywebfs start
$ pywebfs status
$ pywebfs stop
```
* log of server are stored in `~/.pywebfs/pwfs_<listen>:<port>.log`
## Disclaimer
As built on python http.server, read in the python3 documentation:
>Warning
>http.server is not recommended for production. It only implements basic security checks.
Raw data
{
"_id": null,
"home_page": "https://github.com/joknarf/pywebfs",
"name": "pywebfs",
"maintainer": "Franck Jouvanceau",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "http, fileserver, browser, explorer",
"author": "Franck Jouvanceau",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/bb/34/8807f32eab7866ce0068045fb5eef330b65ff11ca732d859bb14b594ae6b/pywebfs-1.0.10.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/pywebfs/)\n\n[](https://shields.io/)\n[](https://pepy.tech/project/pywebfs)\n[](https://shields.io/)\n\n# pywebfs\nSimple Python HTTP(S) File Server\n\n## Install\n```\n$ pip install pywebfs\n```\n\n## Quick start\n\n* start http server sharing current directory listening on 0.0.0.0 port 8080\n```\n$ pywebfs\n```\n\n* Browse/Download/Search files using browser `http://<yourserver>:8080`\n\n\n* search text in files (grep)\n\n\n## features\n\n* Serve static files\n* Download folder as zip file\n* Filter files\n* Search files recursively multiple word any order (disable feature with --nosearch)\n* Search text in files recursively\n* Basic Auth support (single user)\n* HTTPS support\n* HTTPS self-signed certificate generator\n* Display owner/group/permissions (POSIX) (disable feature with --noperm)\n* Can be started as a daemon (POSIX)\n\n## Customize server\n```\n$ pywebfs --dir /mydir --title \"my fileserver\" --listen 0.0.0.0 --port 8080\n$ pywebfs -d /mydir -t \"my fileserver\" -l 0.0.0.0 -p 8080\n```\n\n## Basic auth user/password\n```\n$ pywebfs --dir /mydir --user myuser [--password mypass]\n$ pywebfs -d /mydir -u myuser [-P mypass]\n```\nGenerated password is given if no `--pasword` option\n\n## HTTPS server\n\n* Generate auto-signed certificate and start https server\n```\n$ pywebfs --dir /mydir --gencert\n$ pywebfs -d /mydir --g\n```\n\n* Start https server using existing certificate\n```\n$ pywebfs --dir /mydir --cert /pathto/host.cert --key /pathto/host.key\n$ pywebfs -d /mydir -c /pathto/host.cert -k /pathto/host.key\n```\n\n## Launch server as a daemon (Linux)\n\n```\n$ pywebfs start\n$ pywebfs status\n$ pywebfs stop\n```\n* log of server are stored in `~/.pywebfs/pwfs_<listen>:<port>.log`\n\n## Disclaimer\n\nAs built on python http.server, read in the python3 documentation:\n\n>Warning\n>http.server is not recommended for production. It only implements basic security checks.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 joknarf Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Simple Python HTTP File Server",
"version": "1.0.10",
"project_urls": {
"Documentation": "https://github.com/joknarf/pywebfs/blob/main/README.md",
"Homepage": "https://github.com/joknarf/pywebfs",
"Repository": "https://github.com/joknarf/pywebfs.git"
},
"split_keywords": [
"http",
" fileserver",
" browser",
" explorer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0a35b9641ceadd01de87f422a54337e3e010d01ac662f69502f57ffc5556823",
"md5": "3355b1856773ed15d1fc586ecde954fa",
"sha256": "d596b68b77350cb0ab137b9418c2d074784180b2e67b51f327d311a2e127da0c"
},
"downloads": -1,
"filename": "pywebfs-1.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3355b1856773ed15d1fc586ecde954fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 19425,
"upload_time": "2024-12-18T07:44:09",
"upload_time_iso_8601": "2024-12-18T07:44:09.715699Z",
"url": "https://files.pythonhosted.org/packages/d0/a3/5b9641ceadd01de87f422a54337e3e010d01ac662f69502f57ffc5556823/pywebfs-1.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb348807f32eab7866ce0068045fb5eef330b65ff11ca732d859bb14b594ae6b",
"md5": "eb3933d2c234d4c59ee2d4a17f901b70",
"sha256": "b9e6ecc1c64162bafd187b09dbbb1a46c714bd4c5ce5c9a0ade6130178f80353"
},
"downloads": -1,
"filename": "pywebfs-1.0.10.tar.gz",
"has_sig": false,
"md5_digest": "eb3933d2c234d4c59ee2d4a17f901b70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 22671,
"upload_time": "2024-12-18T07:44:10",
"upload_time_iso_8601": "2024-12-18T07:44:10.669564Z",
"url": "https://files.pythonhosted.org/packages/bb/34/8807f32eab7866ce0068045fb5eef330b65ff11ca732d859bb14b594ae6b/pywebfs-1.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 07:44:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joknarf",
"github_project": "pywebfs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pywebfs"
}
