klr-um 1.0.0__tar.gz

klr_um-1.0.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: klr-um
+Version: 1.0.0
+Summary: Flutter lab study pack (experiments 1-6) bundled as a Python package.
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# klr-um
+
+Flutter lab experiments 1 to 6, ready to print or save.
+
+```
+pip install klr-um
+```
+
+## Print an experiment's code
+
+```python
+import klr
+print(klr.exp1)      # complete main.dart of experiment 1
+print(klr.exp4)      # ... same for exp1 to exp6
+```
+
+## Save to disk
+
+```python
+klr.exp1.save()        # full Flutter project -> ./exp1   (then: cd exp1 && flutter run)
+klr.exp1.save_code()   # just the code        -> ./exp1_main.dart
+klr.save_all()         # exp1 ... exp6 project folders
+klr.save_pdf()         # Flutter_Lab_Experiments.pdf
+```
+
+## More
+
+```python
+klr.list()                                  # experiment titles
+klr.exp5.files                              # files in the project
+print(klr.exp5.show("lib/firebase_options.dart"))
+klr.get(3)                                  # same as klr.exp3
+```
+
+## Command line
+
+```
+klr            # list experiments
+klr 1          # print experiment 1 code
+klr 1 --save   # save experiment 1 project to ./exp1
+klr all --save # save all projects
+klr pdf        # save the PDF
+```
+
+| # | Experiment |
+|---|---|
+| 1 | Widgets and Layouts (Student Profile) |
+| 2 | Responsive UI |
+| 3 | Input and Forms (Student Registration) |
+| 4 | Form Validation (Sign Up) |
+| 5 | Firestore Search (Search Products) |
+| 6 | Firestore Update Product |
+
+Experiments 5 and 6 use Firebase: replace the placeholder values in
+`lib/firebase_options.dart` with your own project's values (e.g. via `flutterfire configure`).

klr_um-1.0.0/README.md

@@ -0,0 +1,55 @@
+# klr-um
+
+Flutter lab experiments 1 to 6, ready to print or save.
+
+```
+pip install klr-um
+```
+
+## Print an experiment's code
+
+```python
+import klr
+print(klr.exp1)      # complete main.dart of experiment 1
+print(klr.exp4)      # ... same for exp1 to exp6
+```
+
+## Save to disk
+
+```python
+klr.exp1.save()        # full Flutter project -> ./exp1   (then: cd exp1 && flutter run)
+klr.exp1.save_code()   # just the code        -> ./exp1_main.dart
+klr.save_all()         # exp1 ... exp6 project folders
+klr.save_pdf()         # Flutter_Lab_Experiments.pdf
+```
+
+## More
+
+```python
+klr.list()                                  # experiment titles
+klr.exp5.files                              # files in the project
+print(klr.exp5.show("lib/firebase_options.dart"))
+klr.get(3)                                  # same as klr.exp3
+```
+
+## Command line
+
+```
+klr            # list experiments
+klr 1          # print experiment 1 code
+klr 1 --save   # save experiment 1 project to ./exp1
+klr all --save # save all projects
+klr pdf        # save the PDF
+```
+
+| # | Experiment |
+|---|---|
+| 1 | Widgets and Layouts (Student Profile) |
+| 2 | Responsive UI |
+| 3 | Input and Forms (Student Registration) |
+| 4 | Form Validation (Sign Up) |
+| 5 | Firestore Search (Search Products) |
+| 6 | Firestore Update Product |
+
+Experiments 5 and 6 use Firebase: replace the placeholder values in
+`lib/firebase_options.dart` with your own project's values (e.g. via `flutterfire configure`).

klr_um-1.0.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "klr-um"
+version = "1.0.0"
+description = "Flutter lab study pack (experiments 1-6) bundled as a Python package."
+readme = "README.md"
+requires-python = ">=3.9"
+
+[project.scripts]
+klr = "klr.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+klr = ["data/**/*", "data/**/.*"]

klr_um-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

klr_um-1.0.0/src/klr/__init__.py

@@ -0,0 +1,122 @@
+"""KLR - Flutter lab experiments 1 to 6.
+
+    import klr
+
+    print(klr.exp1)          # full Dart code of experiment 1 (lib/main.dart)
+    klr.exp1.save()          # writes the complete Flutter project to ./exp1
+    klr.exp1.save_code()     # writes just main.dart to ./exp1_main.dart
+    klr.exp5.files           # every file in the experiment's project
+    print(klr.exp5.show("lib/firebase_options.dart"))
+
+    klr.list()               # all experiments with titles
+    klr.save_all()           # writes exp1 ... exp6 as project folders
+    klr.save_pdf()           # writes Flutter_Lab_Experiments.pdf
+"""
+from __future__ import annotations
+
+import shutil
+from importlib.resources import files
+from pathlib import Path
+
+__version__ = "1.0.0"
+
+_DATA = files("klr") / "data"
+
+TITLES = {
+    1: "Widgets and Layouts (Student Profile)",
+    2: "Responsive UI",
+    3: "Input and Forms (Student Registration)",
+    4: "Form Validation (Sign Up)",
+    5: "Firestore Search (Search Products)",
+    6: "Firestore Update Product",
+}
+
+
+def _walk(node, prefix=""):
+    for child in sorted(node.iterdir(), key=lambda c: c.name):
+        rel = f"{prefix}{child.name}"
+        if child.is_dir():
+            if child.name != "__pycache__":
+                yield from _walk(child, rel + "/")
+        else:
+            yield rel, child
+
+
+class Experiment:
+    """One lab experiment. ``print(exp)`` shows its full main.dart code."""
+
+    def __init__(self, number: int):
+        self.number = number
+        self.name = f"exp{number}"
+        self.title = TITLES[number]
+        self._root = _DATA / self.name
+
+    @property
+    def code(self) -> str:
+        """The complete main.dart source."""
+        return self.show("lib/main.dart")
+
+    @property
+    def files(self) -> list[str]:
+        """Relative paths of every file in the Flutter project."""
+        return [rel for rel, _ in _walk(self._root)]
+
+    def show(self, file: str) -> str:
+        """Text of any file in the project, e.g. ``"pubspec.yaml"``."""
+        node = self._root.joinpath(*file.split("/"))
+        if not node.is_file():
+            raise FileNotFoundError(f"{self.name} has no file {file!r}. See {self.name}.files")
+        return node.read_text(encoding="utf-8")
+
+    def save(self, dest: str | Path | None = None) -> Path:
+        """Write the complete Flutter project to ``dest`` (default ``./expN``)."""
+        dest = Path(dest or self.name)
+        for rel, node in _walk(self._root):
+            out = dest / rel
+            out.parent.mkdir(parents=True, exist_ok=True)
+            out.write_bytes(node.read_bytes())
+        return dest.resolve()
+
+    def save_code(self, dest: str | Path | None = None) -> Path:
+        """Write only main.dart to ``dest`` (default ``./expN_main.dart``)."""
+        dest = Path(dest or f"{self.name}_main.dart")
+        dest.write_text(self.code, encoding="utf-8")
+        return dest.resolve()
+
+    def __str__(self) -> str:
+        return self.code
+
+    def __repr__(self) -> str:
+        return f"// Experiment {self.number}: {self.title}\n{self.code}"
+
+
+exp1, exp2, exp3, exp4, exp5, exp6 = (Experiment(n) for n in range(1, 7))
+experiments = [exp1, exp2, exp3, exp4, exp5, exp6]
+
+
+def get(number: int) -> Experiment:
+    """Experiment by number, e.g. ``klr.get(3)``."""
+    if number not in TITLES:
+        raise ValueError(f"Experiments are numbered 1 to {len(TITLES)}.")
+    return experiments[number - 1]
+
+
+def list() -> None:  # noqa: A001 - short name on purpose
+    """Print every experiment with its title."""
+    for e in experiments:
+        print(f"exp{e.number}: {e.title}")
+
+
+def save_all(dest: str | Path = ".") -> Path:
+    """Write every experiment project into ``dest`` as exp1 ... exp6."""
+    dest = Path(dest)
+    for e in experiments:
+        e.save(dest / e.name)
+    return dest.resolve()
+
+
+def save_pdf(dest: str | Path = "Flutter_Lab_Experiments.pdf") -> Path:
+    """Write the lab manual PDF."""
+    dest = Path(dest)
+    dest.write_bytes((_DATA / "extras" / "Flutter_Lab_Experiments.pdf").read_bytes())
+    return dest.resolve()

klr_um-1.0.0/src/klr/cli.py

@@ -0,0 +1,41 @@
+"""klr command line.
+
+  klr                 list experiments
+  klr 1               print the code of experiment 1
+  klr 1 --save        write the full experiment 1 project to ./exp1
+  klr all --save      write all six projects
+  klr pdf             write the lab manual PDF
+"""
+import argparse
+import sys
+
+import klr
+
+
+def main(argv=None):
+    ap = argparse.ArgumentParser(prog="klr", description=__doc__,
+                                 formatter_class=argparse.RawDescriptionHelpFormatter)
+    ap.add_argument("target", nargs="?", help="experiment number 1-6, 'all' or 'pdf'")
+    ap.add_argument("--save", action="store_true", help="write the project to disk")
+    ap.add_argument("-o", "--out", help="output folder or file")
+    a = ap.parse_args(argv)
+    t = a.target
+    if t is None:
+        klr.list()
+    elif t == "pdf":
+        print(f"Saved {klr.save_pdf(a.out or 'Flutter_Lab_Experiments.pdf')}")
+    elif t == "all":
+        if a.save:
+            print(f"Saved all experiments in {klr.save_all(a.out or '.')}")
+        else:
+            for e in klr.experiments:
+                print(repr(e))
+    elif t.removeprefix("exp").isdigit() and int(t.removeprefix("exp")) in klr.TITLES:
+        e = klr.get(int(t.removeprefix("exp")))
+        print(f"Saved {e.save(a.out)}") if a.save else sys.stdout.write(e.code)
+    else:
+        sys.exit("klr: target must be 1-6, 'all' or 'pdf'")
+
+
+if __name__ == "__main__":
+    main()

klr_um-1.0.0/src/klr/data/exp1/.gitignore

@@ -0,0 +1,48 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.build/
+.buildlog/
+.history
+.svn/
+.swiftpm/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins-dependencies
+.pub-cache/
+.pub/
+/build/
+/coverage/
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release
+
+# Widget Preview related
+.widget_preview/

klr_um-1.0.0/src/klr/data/exp1/.metadata

@@ -0,0 +1,30 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: "c197ca5199e9ee5661e865596c9c07294dfab51c"
+  channel: "stable"
+
+project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: c197ca5199e9ee5661e865596c9c07294dfab51c
+      base_revision: c197ca5199e9ee5661e865596c9c07294dfab51c
+    - platform: web
+      create_revision: c197ca5199e9ee5661e865596c9c07294dfab51c
+      base_revision: c197ca5199e9ee5661e865596c9c07294dfab51c
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'

klr_um-1.0.0/src/klr/data/exp1/README.md

@@ -0,0 +1,17 @@
+# exp1
+
+A new Flutter project.
+
+## Getting Started
+
+This project is a starting point for a Flutter application.
+
+A few resources to get you started if this is your first Flutter project:
+
+- [Learn Flutter](https://docs.flutter.dev/get-started/learn-flutter)
+- [Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
+- [Flutter learning resources](https://docs.flutter.dev/reference/learning-resources)
+
+For help getting started with Flutter development, view the
+[online documentation](https://docs.flutter.dev/), which offers tutorials,
+samples, guidance on mobile development, and a full API reference.

klr_um-1.0.0/src/klr/data/exp1/analysis_options.yaml

@@ -0,0 +1,33 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+analyzer:
+  exclude:
+    - build/**
+    - web/**
+
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at https://dart.dev/lints.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

klr_um-1.0.0/src/klr/data/exp1/exp1.iml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/lib" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/.dart_tool" />
+      <excludeFolder url="file://$MODULE_DIR$/.idea" />
+      <excludeFolder url="file://$MODULE_DIR$/build" />
+    </content>
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" name="Dart SDK" level="project" />
+    <orderEntry type="library" name="Flutter Plugins" level="project" />
+    <orderEntry type="library" name="Dart Packages" level="project" />
+  </component>
+</module>

klr_um-1.0.0/src/klr/data/exp1/lib/main.dart

@@ -0,0 +1,155 @@
+import 'package:flutter/material.dart';
+
+void main() {
+  runApp(const MyApp());
+}
+
+class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      debugShowCheckedModeBanner: false,
+      title: 'Widgets and Layouts',
+      theme: ThemeData(colorSchemeSeed: Colors.indigo),
+      home: const ProfilePage(),
+    );
+  }
+}
+
+class ProfilePage extends StatelessWidget {
+  const ProfilePage({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(title: const Text('Student Profile')),
+      body: Padding(
+        padding: const EdgeInsets.all(16),
+        child: Column(
+          crossAxisAlignment: CrossAxisAlignment.start,
+          children: [
+            // Row -> avatar and name side by side
+            Row(
+              children: [
+                // Stack -> small green dot placed over the avatar
+                Stack(
+                  children: const [
+                    CircleAvatar(
+                      radius: 35,
+                      child: Icon(Icons.person, size: 40),
+                    ),
+                    Positioned(
+                      right: 0,
+                      bottom: 0,
+                      child: CircleAvatar(
+                        radius: 9,
+                        backgroundColor: Colors.green,
+                      ),
+                    ),
+                  ],
+                ),
+                const SizedBox(width: 16),
+                Column(
+                  crossAxisAlignment: CrossAxisAlignment.start,
+                  children: const [
+                    Text(
+                      'Your Name',
+                      style: TextStyle(
+                          fontSize: 22, fontWeight: FontWeight.bold),
+                    ),
+                    Text('B.Tech CSE - 3rd Year'),
+                  ],
+                ),
+              ],
+            ),
+            const SizedBox(height: 20),
+
+            // Container with decoration
+            Container(
+              width: double.infinity,
+              padding: const EdgeInsets.all(12),
+              decoration: BoxDecoration(
+                color: Colors.indigo.shade50,
+                borderRadius: BorderRadius.circular(10),
+                border: Border.all(color: Colors.indigo),
+              ),
+              child: const Text(
+                  'In Flutter, everything on the screen is a widget.'),
+            ),
+            const SizedBox(height: 20),
+
+            // Expanded -> three boxes share the width equally
+            Row(
+              children: [
+                Expanded(child: infoBox('Subjects', '6', Colors.orange)),
+                const SizedBox(width: 8),
+                Expanded(child: infoBox('Labs', '4', Colors.green)),
+                const SizedBox(width: 8),
+                Expanded(child: infoBox('CGPA', '8.4', Colors.purple)),
+              ],
+            ),
+            const SizedBox(height: 20),
+
+            const Text(
+              'Skills',
+              style: TextStyle(fontSize: 18, fontWeight: FontWeight.bold),
+            ),
+            // ListView inside Column must be wrapped in Expanded
+            Expanded(
+              child: ListView(
+                children: const [
+                  Card(
+                    child: ListTile(
+                      leading: Icon(Icons.code),
+                      title: Text('Dart'),
+                      subtitle: Text('Programming language'),
+                    ),
+                  ),
+                  Card(
+                    child: ListTile(
+                      leading: Icon(Icons.phone_android),
+                      title: Text('Flutter'),
+                      subtitle: Text('UI toolkit'),
+                    ),
+                  ),
+                  Card(
+                    child: ListTile(
+                      leading: Icon(Icons.storage),
+                      title: Text('Firebase'),
+                      subtitle: Text('Backend and database'),
+                    ),
+                  ),
+                ],
+              ),
+            ),
+          ],
+        ),
+      ),
+    );
+  }
+
+  // helper method that returns a small coloured box
+  Widget infoBox(String title, String value, Color color) {
+    return Container(
+      padding: const EdgeInsets.all(12),
+      decoration: BoxDecoration(
+        color: color,
+        borderRadius: BorderRadius.circular(8),
+      ),
+      child: Column(
+        children: [
+          Text(
+            value,
+            style: const TextStyle(
+                fontSize: 20,
+                color: Colors.white,
+                fontWeight: FontWeight.bold),
+          ),
+          Text(title, style: const TextStyle(color: Colors.white)),
+        ],
+      ),
+    );
+  }
+}