Browse Source

Add README.md

Sebastian Lohff 7 months ago
parent
commit
14771695c4
2 changed files with 38 additions and 1 deletions
  1. 33
    0
      README.md
  2. 5
    1
      setup.py

+ 33
- 0
README.md View File

@@ -0,0 +1,33 @@
1
+Servefile
2
+=========
3
+
4
+Serve files from shell via a small HTTP server. The server redirects all HTTP
5
+requests to the file, so only IP and port must be given to another user to
6
+access the file. Its main purpose is to quickly send a file to users in your
7
+local network, independent of their current setup (OS/software). Besides that
8
+it also supports uploads, SSL, HTTP basic auth and directory listings.
9
+
10
+Features:
11
+ * serve single file
12
+ * serve a directory with directory index
13
+ * file upload via webinterface
14
+ * HTTPS with on the fly generated self signed SSL certificates
15
+ * HTTP basic authentication
16
+ * serving files/directories as on request generated tar files
17
+
18
+Install
19
+-------
20
+
21
+Via pip
22
+```shell
23
+pip install servefile
24
+```
25
+After installation either execute `servefile --help` or `python -m servefile --help`
26
+
27
+Standalone:
28
+If you don't have pip available just copy `servefile/servefile.py` onto the target machine, make it executable and you are ready to go.
29
+```shell
30
+$ wget https://raw.githubusercontent.com/sebageek/servefile/master/servefile/servefile.py -O servefile
31
+$ chmod +x servefile
32
+$ ./servefile --help
33
+```

+ 5
- 1
setup.py View File

@@ -2,10 +2,14 @@
2 2
 
3 3
 from setuptools import setup
4 4
 
5
+with open("README.md") as f:
6
+    long_description = f.read()
7
+
5 8
 setup(
6 9
     name='servefile',
7 10
     description='Serve files from shell via a small HTTP server',
8
-    long_description='Serve files from shell via a small HTTP server. The server redirects all HTTP requests to the file, so only IP and port must be given to another user to access the file. Its main purpose is to quickly send a file to users in your local network, independent of their current setup (OS/software). Beneath that it also supports uploads, SSL, HTTP basic auth and directory listings.',
11
+    long_description=long_description,
12
+    long_description_content_type='text/markdown',
9 13
     platforms='posix',
10 14
     version='0.4.4',
11 15
     license='GPLv3 or later',

Loading…
Cancel
Save