pyfiche/README.md
Kumi 9c485c7875
Add PyFiche pastebin service with servers and configs
Introducing PyFiche, a pastebin service optimized for command-line usage, including a full suite of servers – a TCP-based 'Fiche' server, an HTTP 'Lines' server, and a 'Recup' server for file retrieval via netcat. The initial release features configuration via pyproject.toml, a comprehensive README, and the MIT license.

This robust solution allows for easy code snippet sharing, file uploads, and downloads without dependencies outside the Python standard library. Setup involves environment configuration and pip installation with the project's handle to git. The 'Fiche' server accepts specific command-line options for customizability, and banlists/allowlists manage server access control, with detailed logging available per user request. Users should note that HTTPS support requires a reverse proxy setup, as PyFiche itself does not handle SSL/TLS.

The '.gitignore' file ensures that local development directories, bytecode and sensitive files are excluded from the repository to maintain a clean working environment. This addition represents a significant milestone for the Private.coffee team in providing a self-contained pastebin service.
2024-01-21 21:38:17 +01:00

1.4 KiB

PyFiche

PyFiche is a simple pastebin optimized for the command line, written in Python and heavily inspired by fiche, or rather a shameless translation.

It also comes with a re-implementation of Lines, the HTTP server that comes with Fiche, which this time allows you to upload files, and comes doesn't have dependencies outside the standard library. 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

$ python -m venv venv
$ source venv/bin/activate
$ pip install -U git+https://kumig.it/PrivateCoffee/pyfiche.git

Usage

Fiche Server

$ 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

$ source venv/bin/activate
$ pyfiche-recup # try --help for options

Lines Server

$ source venv/bin/activate
$ pyfiche-lines # try --help for options

License

PyFiche is licensed under the MIT license. See the LICENSE file for more information.