beam-lan 0.1.0__tar.gz

beam_lan-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.DS_Store

beam_lan-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 0.1.0
+
+First release.
+
+- `beam.send(folder)` zips a project, encrypts it (AES-256-GCM) and uploads it
+  to a free temporary file host. It returns a code that works from anywhere
+  for 3 days with `beam.receive(code)`. The key is part of the code and never
+  reaches the host.
+- `beam.send(folder, lan=True)` sends directly to a laptop on the same network
+  instead. The receiver finds the sender by the code alone.
+- `beam.pack(folder)` only makes the zip.
+- `exclude=[".mp4", ".log"]` leaves file types out. `.venv`, `.git`,
+  `__pycache__`, `node_modules`, `.env` and similar are skipped by default.
+- The zip includes a `start.bat` that creates a virtual environment, installs
+  requirements (read from the project's imports when it has no
+  `requirements.txt`) and runs the project. It handles plain Python,
+  Streamlit, Django, Node and static-HTML projects.

beam_lan-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nylonxd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

beam_lan-0.1.0/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.5
+Name: beam-lan
+Version: 0.1.0
+Summary: Zip a project and send it to anyone, anywhere, with a start.bat that sets it up and runs it.
+Project-URL: Homepage, https://github.com/NYLONXD/beam
+Project-URL: Source, https://github.com/NYLONXD/beam
+Project-URL: Issues, https://github.com/NYLONXD/beam/issues
+Project-URL: Changelog, https://github.com/NYLONXD/beam/blob/main/CHANGELOG.md
+Author-email: Nylonxd <Himanshujha202005@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Nylonxd
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: encrypted,file-transfer,lan,project,share,start.bat,zip
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications :: File Sharing
+Classifier: Topic :: System :: Archiving
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: cryptography>=42
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# beam
+
+Zip a project and send it to anyone, anywhere, from Python. The zip includes
+a `start.bat`: the other person double-clicks it and the project is set up
+and running, with no manual installs.
+
+```python
+import beam
+
+beam.send("D:/projects/my_app", exclude=[".mp4", ".log"])
+# code : tqWFGE-RX2oLb5xjRDX8d0M
+```
+
+The other person, on any network, any time in the next 3 days:
+
+```python
+import beam
+
+beam.receive("tqWFGE-RX2oLb5xjRDX8d0M")
+```
+
+Python 3.9+. Works on Windows, macOS and Linux (`start.bat` is for Windows).
+
+## Install
+
+On both laptops:
+
+```bash
+pip install beam-lan
+```
+
+## Send a project
+
+```python
+import beam
+
+code = beam.send(
+    "D:/projects/my_app",        # the project folder
+    exclude=[".mp4", ".log"],    # file types to leave out (optional)
+    main="app.py",               # what start.bat runs (optional, auto-detected)
+)
+```
+
+It zips the folder, encrypts it, uploads it, and prints a code. Send the code
+to the other person however you like: WhatsApp, email, chat. You can close
+your laptop straight after; the other person can download it any time within
+3 days.
+
+To send a file you already have, such as a zip or a PDF, pass its path instead
+of a folder. It is sent as it is.
+
+## Receive it
+
+```python
+import beam
+
+beam.receive("tqWFGE-RX2oLb5xjRDX8d0M")                      # saves my_app.zip here
+beam.receive("tqWFGE-RX2oLb5xjRDX8d0M", out="D:/Downloads")  # or somewhere else
+beam.receive("tqWFGE-RX2oLb5xjRDX8d0M", extract=True)        # also unzip it
+```
+
+An existing `my_app.zip` is never overwritten: the new one becomes
+`my_app (1).zip` unless you pass `overwrite=True`.
+
+## Same Wi-Fi, direct
+
+For big folders on the same network, skip the internet:
+
+```python
+beam.send("D:/projects/my_app", lan=True)   # prints a short code, e.g. ab3f9c
+beam.receive("ab3f9c")                       # on the other laptop, same Wi-Fi
+```
+
+This mode has no size limit and uploads nothing, and the receiver finds the
+sender by itself. Both laptops must be on at the same time, and `send` waits
+until the other laptop has the file.
+
+## Only make the zip
+
+```python
+beam.pack("D:/projects/my_app")                         # -> D:/projects/my_app.zip
+beam.pack("D:/projects/my_app", output="D:/share/app.zip", exclude=[".csv"])
+```
+
+## What goes in the zip
+
+- **Your files**, minus things that should not travel: `.venv`, `venv`,
+  `__pycache__`, `.git`, `node_modules`, `.env` (secrets) and similar caches.
+  Virtual environments do not work when copied to another computer; `start.bat`
+  builds a fresh one instead.
+- **Your `exclude` list.** `".mp4"`, `"mp4"` and `"*.mp4"` all skip mp4 files.
+  A plain name such as `"data"` skips a file or folder with that name. A
+  `.beamignore` file in the project adds more patterns, one per line.
+- **`start.bat`**, which does the setup and starts the project.
+- **`requirements.txt`**. Your own is used if the project has one. Otherwise
+  beam reads the project's `import` lines and writes one (for example
+  `import cv2` becomes `opencv-python`). Pass `requirements=["flask", "numpy"]`
+  to set the list yourself.
+
+## What start.bat does
+
+| Project | start.bat |
+| --- | --- |
+| Python (`main.py`, `app.py`, `run.py`, ... or `main=`) | creates `.venv`, installs `requirements.txt`, runs the script |
+| Streamlit app | same setup, then `streamlit run app.py` |
+| Django (`manage.py`) | same setup, then `manage.py runserver` |
+| Node (`package.json`) | `npm install`, then `npm start` |
+| Website (`index.html`) | opens it in the browser |
+
+The setup runs once. After that, `start.bat` goes straight to starting the
+project. If Python or Node.js is missing, it says where to download it. To
+start over, delete the `.venv` folder.
+
+Turn it off with `start_script=False`.
+
+## How the internet transfer works
+
+1. The zip is encrypted on your laptop with AES-256-GCM, using a random key.
+2. The encrypted file is uploaded to a free temporary file host:
+   [temp.sh](https://temp.sh) (up to 4 GB, kept 3 days), or
+   [uguu.se](https://uguu.se) (up to 128 MB, kept 3 hours) if temp.sh is down.
+3. The code is `<where it is>-<the key>`. The key never goes to the host, so
+   the host only ever stores unreadable data.
+4. `receive` downloads it, checks it has not been changed, and decrypts it.
+
+Anyone who has the whole code can download the file, so send it only to the
+person it is for.
+
+## All options
+
+`beam.send(path, ...)` and `beam.pack(path, ...)`
+
+| Option | Default | Effect |
+| --- | --- | --- |
+| `exclude` | none | file types or names to leave out |
+| `main` | auto | script that `start.bat` runs |
+| `start_script` | `True` | add `start.bat` (and `requirements.txt` if needed) |
+| `requirements` | auto | pip packages `start.bat` installs |
+| `use_default_excludes` | `True` | skip `.venv`, `.git`, `__pycache__`, ... |
+| `max_size_mb` | none | skip files bigger than this |
+| `quiet` | `False` | print nothing |
+
+`beam.pack` only: `output` sets where the zip goes (default `<folder>.zip`
+next to the folder).
+
+`beam.send` only: `lan=True` sends directly over the same Wi-Fi. With
+`lan=True`, `code` picks your own code, `timeout` sets how many seconds to
+wait for the other laptop, and `port` sets the network port (default 8765,
+another free port is used if it is taken).
+
+`beam.receive(code, ...)`: `out` sets the folder to save into, `extract` also
+unzips it, and `overwrite` replaces existing files. For LAN codes, `host="IP"`
+or `host="IP:port"` skips the search and `wait` sets how many seconds to
+search (default 15).
+
+Errors raise `beam.BeamError`.
+
+## Troubleshooting
+
+**`nothing found for this code ... expired`**: the file is older than 3 days
+(3 hours if it went to uguu.se), or the code was not copied completely.
+Send it again.
+
+**`could not decrypt: wrong code`**: part of the code is missing or mistyped.
+
+**`upload failed on every host`**: check the internet connection. If the hosts
+are down, use `beam.pack` and share the zip another way.
+
+**LAN mode: `no sender with code ... found`**
+
+- Check both laptops are on the same Wi-Fi. Guest and office networks often
+  block devices from seeing each other.
+- On Windows, click **Allow** when the firewall asks about Python on the
+  sending laptop.
+- Use the address the sender prints: `beam.receive("ab3f9c", host="192.168.1.42:8765")`.
+
+## Limits
+
+- Internet mode depends on free third-party hosts. They can change their rules
+  or go offline; beam falls back from temp.sh to uguu.se, but it cannot promise
+  either is up. Files over 4 GB need `lan=True`.
+- `start.bat` is for Windows. On macOS or Linux, unzip the file and install
+  `requirements.txt` yourself.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+ruff check .
+python -m build
+```
+
+## License
+
+MIT

beam_lan-0.1.0/README.md

@@ -0,0 +1,196 @@
+# beam
+
+Zip a project and send it to anyone, anywhere, from Python. The zip includes
+a `start.bat`: the other person double-clicks it and the project is set up
+and running, with no manual installs.
+
+```python
+import beam
+
+beam.send("D:/projects/my_app", exclude=[".mp4", ".log"])
+# code : tqWFGE-RX2oLb5xjRDX8d0M
+```
+
+The other person, on any network, any time in the next 3 days:
+
+```python
+import beam
+
+beam.receive("tqWFGE-RX2oLb5xjRDX8d0M")
+```
+
+Python 3.9+. Works on Windows, macOS and Linux (`start.bat` is for Windows).
+
+## Install
+
+On both laptops:
+
+```bash
+pip install beam-lan
+```
+
+## Send a project
+
+```python
+import beam
+
+code = beam.send(
+    "D:/projects/my_app",        # the project folder
+    exclude=[".mp4", ".log"],    # file types to leave out (optional)
+    main="app.py",               # what start.bat runs (optional, auto-detected)
+)
+```
+
+It zips the folder, encrypts it, uploads it, and prints a code. Send the code
+to the other person however you like: WhatsApp, email, chat. You can close
+your laptop straight after; the other person can download it any time within
+3 days.
+
+To send a file you already have, such as a zip or a PDF, pass its path instead
+of a folder. It is sent as it is.
+
+## Receive it
+
+```python
+import beam
+
+beam.receive("tqWFGE-RX2oLb5xjRDX8d0M")                      # saves my_app.zip here
+beam.receive("tqWFGE-RX2oLb5xjRDX8d0M", out="D:/Downloads")  # or somewhere else
+beam.receive("tqWFGE-RX2oLb5xjRDX8d0M", extract=True)        # also unzip it
+```
+
+An existing `my_app.zip` is never overwritten: the new one becomes
+`my_app (1).zip` unless you pass `overwrite=True`.
+
+## Same Wi-Fi, direct
+
+For big folders on the same network, skip the internet:
+
+```python
+beam.send("D:/projects/my_app", lan=True)   # prints a short code, e.g. ab3f9c
+beam.receive("ab3f9c")                       # on the other laptop, same Wi-Fi
+```
+
+This mode has no size limit and uploads nothing, and the receiver finds the
+sender by itself. Both laptops must be on at the same time, and `send` waits
+until the other laptop has the file.
+
+## Only make the zip
+
+```python
+beam.pack("D:/projects/my_app")                         # -> D:/projects/my_app.zip
+beam.pack("D:/projects/my_app", output="D:/share/app.zip", exclude=[".csv"])
+```
+
+## What goes in the zip
+
+- **Your files**, minus things that should not travel: `.venv`, `venv`,
+  `__pycache__`, `.git`, `node_modules`, `.env` (secrets) and similar caches.
+  Virtual environments do not work when copied to another computer; `start.bat`
+  builds a fresh one instead.
+- **Your `exclude` list.** `".mp4"`, `"mp4"` and `"*.mp4"` all skip mp4 files.
+  A plain name such as `"data"` skips a file or folder with that name. A
+  `.beamignore` file in the project adds more patterns, one per line.
+- **`start.bat`**, which does the setup and starts the project.
+- **`requirements.txt`**. Your own is used if the project has one. Otherwise
+  beam reads the project's `import` lines and writes one (for example
+  `import cv2` becomes `opencv-python`). Pass `requirements=["flask", "numpy"]`
+  to set the list yourself.
+
+## What start.bat does
+
+| Project | start.bat |
+| --- | --- |
+| Python (`main.py`, `app.py`, `run.py`, ... or `main=`) | creates `.venv`, installs `requirements.txt`, runs the script |
+| Streamlit app | same setup, then `streamlit run app.py` |
+| Django (`manage.py`) | same setup, then `manage.py runserver` |
+| Node (`package.json`) | `npm install`, then `npm start` |
+| Website (`index.html`) | opens it in the browser |
+
+The setup runs once. After that, `start.bat` goes straight to starting the
+project. If Python or Node.js is missing, it says where to download it. To
+start over, delete the `.venv` folder.
+
+Turn it off with `start_script=False`.
+
+## How the internet transfer works
+
+1. The zip is encrypted on your laptop with AES-256-GCM, using a random key.
+2. The encrypted file is uploaded to a free temporary file host:
+   [temp.sh](https://temp.sh) (up to 4 GB, kept 3 days), or
+   [uguu.se](https://uguu.se) (up to 128 MB, kept 3 hours) if temp.sh is down.
+3. The code is `<where it is>-<the key>`. The key never goes to the host, so
+   the host only ever stores unreadable data.
+4. `receive` downloads it, checks it has not been changed, and decrypts it.
+
+Anyone who has the whole code can download the file, so send it only to the
+person it is for.
+
+## All options
+
+`beam.send(path, ...)` and `beam.pack(path, ...)`
+
+| Option | Default | Effect |
+| --- | --- | --- |
+| `exclude` | none | file types or names to leave out |
+| `main` | auto | script that `start.bat` runs |
+| `start_script` | `True` | add `start.bat` (and `requirements.txt` if needed) |
+| `requirements` | auto | pip packages `start.bat` installs |
+| `use_default_excludes` | `True` | skip `.venv`, `.git`, `__pycache__`, ... |
+| `max_size_mb` | none | skip files bigger than this |
+| `quiet` | `False` | print nothing |
+
+`beam.pack` only: `output` sets where the zip goes (default `<folder>.zip`
+next to the folder).
+
+`beam.send` only: `lan=True` sends directly over the same Wi-Fi. With
+`lan=True`, `code` picks your own code, `timeout` sets how many seconds to
+wait for the other laptop, and `port` sets the network port (default 8765,
+another free port is used if it is taken).
+
+`beam.receive(code, ...)`: `out` sets the folder to save into, `extract` also
+unzips it, and `overwrite` replaces existing files. For LAN codes, `host="IP"`
+or `host="IP:port"` skips the search and `wait` sets how many seconds to
+search (default 15).
+
+Errors raise `beam.BeamError`.
+
+## Troubleshooting
+
+**`nothing found for this code ... expired`**: the file is older than 3 days
+(3 hours if it went to uguu.se), or the code was not copied completely.
+Send it again.
+
+**`could not decrypt: wrong code`**: part of the code is missing or mistyped.
+
+**`upload failed on every host`**: check the internet connection. If the hosts
+are down, use `beam.pack` and share the zip another way.
+
+**LAN mode: `no sender with code ... found`**
+
+- Check both laptops are on the same Wi-Fi. Guest and office networks often
+  block devices from seeing each other.
+- On Windows, click **Allow** when the firewall asks about Python on the
+  sending laptop.
+- Use the address the sender prints: `beam.receive("ab3f9c", host="192.168.1.42:8765")`.
+
+## Limits
+
+- Internet mode depends on free third-party hosts. They can change their rules
+  or go offline; beam falls back from temp.sh to uguu.se, but it cannot promise
+  either is up. Files over 4 GB need `lan=True`.
+- `start.bat` is for Windows. On macOS or Linux, unzip the file and install
+  `requirements.txt` yourself.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+ruff check .
+python -m build
+```
+
+## License
+
+MIT

beam_lan-0.1.0/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "beam-lan"
+dynamic = ["version"]
+description = "Zip a project and send it to anyone, anywhere, with a start.bat that sets it up and runs it."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+authors = [{ name = "Nylonxd", email = "Himanshujha202005@gmail.com" }]
+keywords = ["file-transfer", "share", "zip", "project", "encrypted", "lan", "start.bat"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+    "Topic :: Communications :: File Sharing",
+    "Topic :: System :: Archiving",
+]
+dependencies = ["cryptography>=42"]
+
+[project.optional-dependencies]
+dev = ["pytest>=7", "ruff>=0.4", "build", "twine"]
+
+[project.urls]
+Homepage = "https://github.com/NYLONXD/beam"
+Source = "https://github.com/NYLONXD/beam"
+Issues = "https://github.com/NYLONXD/beam/issues"
+Changelog = "https://github.com/NYLONXD/beam/blob/main/CHANGELOG.md"
+
+[tool.hatch.version]
+path = "src/beam/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/beam"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/beam", "tests", "README.md", "LICENSE", "CHANGELOG.md"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]

beam_lan-0.1.0/src/beam/__init__.py

@@ -0,0 +1,31 @@
+"""beam - zip a project and send it to another laptop, anywhere.
+
+    import beam
+
+    code = beam.send("D:/projects/my_app", exclude=[".mp4", ".log"])  # laptop A
+    beam.receive(code)                                               # laptop B
+
+    beam.send("D:/projects/my_app", lan=True)   # direct, same Wi-Fi only
+    beam.pack("D:/projects/my_app")             # only make my_app.zip
+
+The zip carries a start.bat that installs what the project needs and runs it.
+"""
+
+__version__ = "0.1.0"  # before the imports: _cloud reads it for its User-Agent
+
+from ._files import DEFAULT_EXCLUDES  # noqa: E402
+from ._protocol import DEFAULT_PORT, BeamError, find_sender, lan_ip  # noqa: E402
+from .packer import pack  # noqa: E402
+from .transfer import receive, send  # noqa: E402
+
+__all__ = [
+    "send",
+    "receive",
+    "pack",
+    "find_sender",
+    "lan_ip",
+    "BeamError",
+    "DEFAULT_EXCLUDES",
+    "DEFAULT_PORT",
+    "__version__",
+]