microweb 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

microweb/cli.py

@@ -215,33 +215,45 @@ def cli():
 @cli.command()
 @click.option('--port', default=None, help='Serial port, e.g., COM10')
 @click.option('--erase', is_flag=True, help='Erase all flash before writing firmware')
-def flash(port, erase):
-    """Flash MicroPython and MicroWeb to the ESP32."""
+@click.option('--esp8266', is_flag=True, help='Flash ESP8266 firmware instead of ESP32')
+@click.option('--firmware', type=click.Path(exists=True), help='Custom firmware .bin file to flash')
+def flash(port, erase, esp8266, firmware):
+    """Flash MicroPython and MicroWeb to the ESP32 or ESP8266."""
     if not port:
         ports = [p.device for p in serial.tools.list_ports.comports()]
         port = ports[0] if ports else None
     if not port:
-        print_colored("No ESP32 found. Specify --port, e.g., --port COM10.", color='red')
+        print_colored("No ESP device found. Specify --port, e.g., --port COM10.", color='red')
         return
+
+    chip_name = "ESP8266" if esp8266 else "ESP32"
+    if firmware:
+        firmware_path = os.path.abspath(firmware)
+        print_colored(f"Using custom firmware: {firmware_path}", color='cyan')
+    else:
+        firmware_file = f"{chip_name}_GENERIC-20250415-v1.25.0.bin"
+        firmware_path = pkg_resources.resource_filename('microweb', f'firmware/{firmware_file}')
+
     if erase:
-        print_colored("You requested --erase. This will erase ALL data on the ESP32!", color='yellow')
+        print_colored(f"You requested --erase. This will erase ALL data on the {chip_name}!", color='yellow')
         confirm = input("Type 'erase' to continue, or anything else to cancel: ")
         if "erase" not in confirm.lower():
             print_colored("Erase cancelled.", color='yellow')
             return
-        print_colored(f"Erasing all flash on {port}...", color='yellow')
+        print_colored(f"Erasing all flash on {port} ({chip_name})...", color='yellow')
         esptool.main(['--port', port, 'erase_flash'])
+
     try:
         print_colored(f"Checking for MicroPython on {port}...", color='blue')
         if check_micropython(port):
             print_colored(f"MicroPython detected on {port}. Skipping firmware flash.", color='green')
         else:
-            firmware_path = pkg_resources.resource_filename('microweb', 'firmware/ESP32_GENERIC-20250415-v1.25.0.bin')
             if not os.path.exists(firmware_path):
-                print_colored(f"Error: Firmware file not found at {firmware_path}. Ensure it is included in the package.", color='red')
+                print_colored(f"Error: Firmware file not found at {firmware_path}.", color='red')
                 return
-            print_colored(f"Flashing firmware on {port}...", color='blue')
+            print_colored(f"Flashing {chip_name} firmware on {port}...", color='blue')
             esptool.main(['--port', port, 'write_flash', '-z', '0x1000', firmware_path])
+
         print_colored("Uploading core files...", color='blue')
         core_files = [
             ('firmware/boot.py', 'boot.py'),
@@ -255,12 +267,15 @@ def flash(port, erase):
                 print_colored(f"Error: Source file {src_path} not found.", color='red')
                 return
             upload_file(src_path, port, destination=dest)
+
         print_colored("Verifying uploaded files...", color='blue')
         verify_files(port, [dest for _, dest in core_files])
-        print_colored("MicroWeb flashed successfully", color='green')
+        print_colored(f"MicroWeb flashed successfully to {chip_name}", color='green')
+
     except Exception as e:
         print_colored(f"Error during flash: {e}", color='red')
 
+
 @cli.command()
 @click.argument('file')
 @click.option('--port', default=None, help='Serial port, e.g., COM10')

{microweb-0.1.1.dist-info → microweb-0.1.2.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: microweb
-Version: 0.1.1
+Version: 0.1.2
 Summary: A web server framework for MicroPython . Easily build and deploy web applications using MicroPython.
 Home-page: https://github.com/ishanoshada/microweb
-Author: Your Name
+Author: Ishan Oshada
 Keywords: micropython,esp32,web server,embedded,iot,http,microcontroller,python
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Embedded Systems
 Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: pyserial
 Requires-Dist: esptool
 Requires-Dist: click
@@ -20,6 +21,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: summary
 
@@ -87,6 +89,7 @@ With MicroWeb, you get routing, templates, JSON, static files, and more—making
 - [Example Usage](#example-usage)
     - [Minimal Example (`tests/2/app.py`)](#minimal-example-tests2apppy)
     - [Static Files and Templates Example (`tests/1/app.py`)](#static-files-and-templates-example-tests1apppy)
+    - [Portfolio Demo (`tests/portfolio/`)](#portfolio-demo-testsportfolio)
 - [Wi-Fi Configuration](#wi-fi-configuration)
 - [Accessing the Web Server](#accessing-the-web-server)
 - [CLI Tool Usage Examples](#cli-tool-usage-examples)
@@ -96,7 +99,7 @@ With MicroWeb, you get routing, templates, JSON, static files, and more—making
 - [Contributing](#contributing)
 - [License](#license)
 
-
+![example](/src/img.jpg)
 
 ## Features
 
@@ -109,7 +112,7 @@ With MicroWeb, you get routing, templates, JSON, static files, and more—making
 - **MicroPython Detection**: Verifies MicroPython before running scripts.
 - **Easy Cleanup**: Remove all files from the ESP32 home directory using `microweb remove --port COM10 --remove`—try this if you need to reset or clean up your device.
 
-![uml](/uml.svg)
+![uml](/src/uml.svg)
 
 ---
 ## Installation
@@ -131,20 +134,30 @@ pip install .
 
 > **Note:** The workspace does not contain a git repository. If you want to contribute or track changes, initialize one with `git init`.
 
+
 ---
 
 ## Usage
 
-### Flashing the ESP32
-
 Flash MicroPython and MicroWeb:
 
 ```bash
 microweb flash --port COM10
 ```
 
-- Erases the ESP32 flash (if `--erase` is used).
-- Uploads core files (`boot.py`, `main.py`, `microweb.py`, `wifi.py`, and all static files).
+#### Options:
+
+* `--erase`
+  Erase the entire flash memory before flashing firmware.
+
+* `--esp8266`
+  Flash ESP8266 firmware instead of the default ESP32.
+
+* `--firmware firmware.bin`
+  Use a custom `.bin` firmware file. This overrides the default firmware for ESP32 or ESP8266 ( any ).
+
+
+
 
 ---
 
@@ -156,15 +169,35 @@ Upload and run a MicroPython script:
 microweb run app.py --port COM10
 ```
 
-After running `app.run()`, the ESP32 will host a Wi-Fi access point (AP) if it cannot connect to a configured network. You can then connect your device to this AP and access the web server using the ESP32's IP address (typically `http://192.168.4.1` in AP mode).
-
-
-- Validates the `.py` file and checks for MicroPython.
+- Validates your `.py` file and checks for MicroPython on the device.
 - Uploads and executes the script.
+- Checks and uploads only changed files by default.
 - Prompts to run `microweb flash` if MicroPython is not detected.
+- After running `app.run()`, the ESP32 will host a Wi-Fi access point (AP) if it cannot connect to a configured network. You can then connect your device to this AP and access the web server using the ESP32's IP address (typically `http://192.168.4.1` in AP mode).
 
 ---
 
+### Boot Script Management
+
+You can configure your ESP32 to automatically start your application after any power cycle or reset by managing the `boot.py` file:
+
+- **Add boot script (auto-run on power-up):**
+    ```bash
+    microweb run app.py --add-boot --port COM10
+    ```
+    This uploads a `boot.py` that will auto-run your app every time the ESP32 is powered on or reset. After upload, you can disconnect the ESP32 from your computer and power it from any source; the server will start automatically.
+
+- **Remove boot script:**
+    ```bash
+    microweb run app.py --remove-boot --port COM10
+    ```
+    This removes the `boot.py` file, so your app will not auto-run on power-up.
+
+---
+
+
+
+
 ## Example Usage
 
 ### Minimal Example (`tests/2/app.py`)
@@ -254,6 +287,21 @@ app.run()
 
 ---
 
+### Portfolio Demo (`tests/portfolio/`)
+
+The `tests/portfolio/` directory contains a full-featured portfolio web app built with MicroWeb, demonstrating:
+
+- Multi-page routing (`/`, `/about`, `/projects`, `/contact`)
+- Dynamic template rendering with variables
+- Static assets (CSS, JS, images)
+- API endpoints (e.g., `/api/info` returns JSON)
+- Responsive, animated UI using HTML/CSS/JS
+- Example of serving a personal portfolio from an ESP32
+
+See `tests/portfolio/app.py` and the `static/` folder for a complete, ready-to-deploy example.
+
+---
+
 ## Wi-Fi Configuration
 
 Configure Wi-Fi via:
@@ -322,6 +370,7 @@ For more details, run `microweb --help`.
 
 ## Project Structure
 
+
 ```
 microweb/
 ├── microweb/
@@ -332,18 +381,13 @@ microweb/
 │   ├── cli.py
 │   ├── firmware/
 │   │   ├── ESP32_GENERIC-20250415-v1.25.0.bin
-│   │   ├── boot.py
-│   │   ├── main.py
-│   ├── static/
-│   │   ├── index.html
-│   │   ├── style.css
-│   │   ├── welcome.html
-│   │   ├── wifi_updated.html
-├── setup.py
-├── README.md
-
+│   │   ├── boot.py         # Minimal boot script 
+│   │   ├── main.py         # Imports and runs your app module
+├── setup.py                # Packaging and install configuration
+├── README.md               # Project documentation
 ```
 
+
 ---
 
 ## Troubleshooting
@@ -361,3 +405,4 @@ Fork and submit pull requests at [https://github.com/ishanoshada/microweb](https
 
 ---
 
+**Repository Views** ![Views](https://profile-counter.glitch.me/microweb/count.svg)

{microweb-0.1.1.dist-info → microweb-0.1.2.dist-info}/RECORD

@@ -1,13 +1,15 @@
 microweb/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-microweb/cli.py,sha256=RGrSlbzwfxB1SffKrxBcinPzft1L3VzdtTHNNWrxmnQ,27065
+microweb/cli.py,sha256=cUfr14gV9uH-DvZFX3nRqr-RduldxfXn0jBIKWXJ7-k,27560
 microweb/microweb.py,sha256=WlDV1Fk5M4EsvmmkWKVLWaoZh6Vgl9G0qORFsQEQ3iM,12799
 microweb/uploader.py,sha256=EGUXscOAQ0gZJKBaRyAr5XzmxCWhabgh-QO3fBE2a38,3097
 microweb/wifi.py,sha256=S2gOOmTKp2G1uUHxOH0DHQ_k7QSERKHDCm89qv-WlKs,904
 microweb/firmware/ESP32_GENERIC-20250415-v1.25.0.bin,sha256=HrGohHPjKqak1F3BtbatQLwfBhKOeqhUjkOM-kYz2hs,1702240
+microweb/firmware/ESP8266_GENERIC-20250415-v1.25.0.bin,sha256=DcEkzHgtDl-BCwap6UbgKhirHjbWepSgd8PonauaVcY,636820
 microweb/firmware/boot.py,sha256=1522jvxAjGk-y7X4mzMilB4pMQ6KrAgosDXRAMtac8k,22
 microweb/firmware/main.py,sha256=g_rg-1qpQEzvQoSnhXairx_v7xHNuGDJVrmbdziKt1A,10
-microweb-0.1.1.dist-info/METADATA,sha256=R-CD1owSm-Sb3cqX0Rj0ApJmnVzTcpkSP3d3vaW_KGU,12058
-microweb-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-microweb-0.1.1.dist-info/entry_points.txt,sha256=yBGjIy-e3mx-HHkmkGNLBcSDEALB327du5KuauZHmg4,46
-microweb-0.1.1.dist-info/top_level.txt,sha256=CkRcDTo-nv4JTieAZPKFC-EGKYYQmKNq5C8zU2k5zRM,9
-microweb-0.1.1.dist-info/RECORD,,
+microweb-0.1.2.dist-info/licenses/LICENSE,sha256=7tSPQeJFv8168MWaFKTWEqYRvM9Lh5xsBh-US0mxUF0,1070
+microweb-0.1.2.dist-info/METADATA,sha256=YGuHvapfLWvPQifBTTlXcKEBVvme5gPNzaXPGNsM2LM,13725
+microweb-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+microweb-0.1.2.dist-info/entry_points.txt,sha256=yBGjIy-e3mx-HHkmkGNLBcSDEALB327du5KuauZHmg4,46
+microweb-0.1.2.dist-info/top_level.txt,sha256=CkRcDTo-nv4JTieAZPKFC-EGKYYQmKNq5C8zU2k5zRM,9
+microweb-0.1.2.dist-info/RECORD,,

microweb-0.1.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ishan Oshada 
+
+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.