Skip to main content

Instantly serve any folder over HTTP with zero configuration and one-click downloads.

Project description

sharemydir

PyPI Python Version License GitHub Release Downloads

Effortlessly serve any folder over HTTP with zero configuration, featuring a mobile-friendly web interface, QR code access, and downloadable folders as ZIP files. Perfect for developers, testers, and anyone needing to share files quickly.

Features

  • Instant HTTP Server: Serve any folder with a single command.
  • Automatic IP Detection: Works seamlessly on your local network.
  • Mobile-Friendly: Access via QR code or URL on any device.
  • Download Folders as ZIP: Easily share entire directories.
  • Individual File Downloads: Grab single files directly from the browser.
  • Clean Web UI: Responsive, intuitive interface for all devices.
  • Zero Config CLI: No setup, just run and share.
  • Elegant Terminal Output: Clear URLs and QR codes for quick access.

Installation

Install sharemydir directly from PyPI:

pip install sharemydir

Alternatively, clone the repository for development:

git clone https://github.com/anilrajrimal1/sharemydir.git
cd sharemydir

Dependencies

  • Requires qrcode for QR code generation:
    pip install qrcode
    

Usage

Serve the current directory:

sharemydir

Serve a specific folder on a custom port:

sharemydir /path/to/folder -p 9000

Example Output

+------------------------------------------------------------+
| Serving folder: /home/anil/demo/sharemydir-demo               |
| URL: http://192.168.1.42:9000/                             |
| Scan this QR code for mobile access:                       |
+------------------------------------------------------------+

Open the URL in a browser or scan the QR code on your mobile device.

Web Interface

  • Table View: Clean, organized display of files and folders.
  • Download Options: Buttons for downloading files or entire folders as ZIP.
  • Responsive Design: Optimized for desktops, tablets, and phones.

CLI Options

Option Description Default
FOLDER Folder to serve Current (.)
-p, --port Port for the server 8080

Graceful Shutdown

Stop the server cleanly with Ctrl+C.

Development

To run locally for development:

python sharemydir.py

Contributing

We welcome contributions! To get started:

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feat/name-your-feature).
  3. Commit your changes (git commit -m 'add amazing feature').
  4. Push to the branch (git push origin feat/name-your-feature).
  5. Open a Pull Request.

Releases

Check out the Releases page for the latest updates, changelogs, and version history.

License

Distributed under the MIT License. © 2025 Anil Raj Rimal. See LICENSE for more information.

Acknowledgments

  • Built with 💖 by Anil Raj Rimal.
  • Powered by Python and open-source libraries.

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

sharemydir-1.0.3.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sharemydir-1.0.3-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file sharemydir-1.0.3.tar.gz.

File metadata

  • Download URL: sharemydir-1.0.3.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for sharemydir-1.0.3.tar.gz
Algorithm Hash digest
SHA256 259f1b8b73fb8e53eff381e5daf430bca6c18c2fcb67e633e4b9d75fc0a18335
MD5 49489cb59588e2d85d98347e31ba1635
BLAKE2b-256 0214276cd12e4492a2dad20e4f2c51cf19789879233df2cc797f0c578d888f88

See more details on using hashes here.

File details

Details for the file sharemydir-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: sharemydir-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for sharemydir-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a59fe22738fcde05d54ba64e2f97df9b01dd9d181d8345cb9fab0b8172b96d38
MD5 2bcdbcc6a8e66e1236ea9f58163c4227
BLAKE2b-256 53e4fb3ad25ee093f4141aeb2ad6aba69ca9be02a560aaf5660261dba09e4a61

See more details on using hashes here.

Supported by

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