Kumi
b23e97e3b8
Updated README to highlight PyFiche's lack of external dependencies, improving project clarity for potential users. Added a stub for the POST method in the Lines server signaling planned upload functionality with an informative 501 Not Implemented response to client requests. This sets the groundwork for future implementations of the file upload feature.
57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
# PyFiche
|
|
|
|
PyFiche is a simple pastebin optimized for the command line, written in Python
|
|
and heavily inspired by [fiche](https://github.com/solusipse/fiche/), or rather
|
|
a shameless translation. It has no dependencies outside the Python standard
|
|
library.
|
|
|
|
It also comes with a re-implementation of Lines, the HTTP server that comes
|
|
with Fiche. Additionally, PyFiche also comes with a simple TCP server, Recup,
|
|
to download pastes through netcat without using HTTP(S), in the same way you
|
|
upload them.
|
|
|
|
## Installation
|
|
|
|
### Dependencies
|
|
|
|
- Python 3 (tested with 3.11)
|
|
|
|
### Local Installation
|
|
|
|
```bash
|
|
$ python -m venv venv
|
|
$ source venv/bin/activate
|
|
$ pip install -U git+https://kumig.it/PrivateCoffee/pyfiche.git
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Fiche Server
|
|
|
|
```bash
|
|
$ source venv/bin/activate
|
|
$ pyfiche-server # try --help for options
|
|
```
|
|
|
|
With the exception of the `-u` option, all arguments of the original Fiche
|
|
should work as expected. `-u` is not implemented because, well, just use the
|
|
right user in the first place. 🤷♀️
|
|
|
|
### Recup Server
|
|
|
|
```bash
|
|
$ source venv/bin/activate
|
|
$ pyfiche-recup # try --help for options
|
|
```
|
|
|
|
### Lines Server
|
|
|
|
```bash
|
|
$ source venv/bin/activate
|
|
$ pyfiche-lines # try --help for options
|
|
```
|
|
|
|
## License
|
|
|
|
PyFiche is licensed under the MIT license. See the [LICENSE](LICENSE) file for
|
|
more information.
|