Skip to main content

A simple flask-based file sharing service

Project description

netfshare

A flask-based local network file sharing tool.

Not for production environements. Use with care.

Installation and use

  1. Install the netfshare python package:

    py -m pip install netfshare

  2. Navigate to the directory that you want to share the contents of.

  3. (OPTIONAL) To secure your WSGI application, set a custom SECRET_KEY environment variable, or create a .env file in the shared directory defining the SECRET_KEY:

     SECRET_KEY=my_secret_key
    
  4. Run netfshare to start the sharing service:

    py -m netfshare

The service cam+n be accessd at <your-local-ip>:5000.

Make sure your machine is discoverable in the local network and that the required firewall rules are active.

Sharing settings

Visit the service website Admin interface from the machine running the service to manage the sharing settings.

netfshare supports downloading the contents (subdirectories) of your shared folder, as well as uploading clients' content to selected directories inside the shared folder.

Only downloads of whole subdirectories are supported, as .zip archives. To make files available for downalod, they must be placed inside a subdirectory of the sharedfolder, and the appropriate sharing mode must be set for this subdirectory in the Admin web interface.

Currently, the supported sharing modes are:

  • read_only: whole subdirectories of the shared folder can be downloaded as a .zip archive.
  • upload_only: clients can upload their data into a selected subdirectory of the shared folder. The uploaded content is placed inside a subfolder with the user's selected name. Currently, only a single upload by each user is allowed.

Localization

netfshare supports localization using flask-babel.

The client-facing routes of the app are translated into English and Slovenian.

To update the translations after adding / modifying app text, run the following to get new text to bt translated and update the Slovenian translation file,:

pybabel extract -F babel.cfg -o messages.pot .
pybabel update -i messages.pot -d netfshare/translations

Now edit / add new translations in translations/sl/LC_MESSAGES/messages.po and compile the new translations:

pybabel compile -d netfshare/translations

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netfshare-0.4.tar.gz (50.4 kB view details)

Uploaded Source

Built Distribution

netfshare-0.4-py3-none-any.whl (52.2 kB view details)

Uploaded Python 3

File details

Details for the file netfshare-0.4.tar.gz.

File metadata

  • Download URL: netfshare-0.4.tar.gz
  • Upload date:
  • Size: 50.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for netfshare-0.4.tar.gz
Algorithm Hash digest
SHA256 62d4825e0a5fceb2f6ff6dc9b97f1f9e207f8fb5742ba5c4facd0bfda6754e50
MD5 6ea3f5e81245dd91e262855e41a1803a
BLAKE2b-256 1c456cc2f96d76af64864c7ddae918f4077f14ad97d74adfe717c01c9951983f

See more details on using hashes here.

File details

Details for the file netfshare-0.4-py3-none-any.whl.

File metadata

  • Download URL: netfshare-0.4-py3-none-any.whl
  • Upload date:
  • Size: 52.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for netfshare-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8fee9de21afde6cd0bbc6608277c7b4ee67e61350dcdf245168d65ee28537531
MD5 4bba7d4562b78c820f8338f501f680bf
BLAKE2b-256 26dfae0f5d36b2b65501a9aa1a77b8258388291d82252aa3c2be917b4d8bd911

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page