Changes for v0.1.1 (#2)

* Small corrections to docs and podspec

* Hide package implementation behind `src`

* Set current dir before running Python program

* Flet example added

* Added `--pre` flag

* Flet example

* Version bump to 0.1.1, added docs, static methods

Author: FeodorFitsner

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.1.1
+
+* Fixed issue with setting current directory on Python start.
+* Added `--pre` flag to `serious_python:main` CLI.
+* Added Flet example.
+* Hid internal implementation behind `src` dir.
+
 ## 0.1.0
 
 * Initial release of `serious_python` with iOS support.

README.md

@@ -44,29 +44,29 @@ platform :ios, '12.0'
 Create an instance of `SeriousPython` class and call its `run()` method:
 
 ```dart
-SeriousPython().run("app/app.zip");
+SeriousPython.run("app/app.zip");
 ```
 
 When the app starts the archive is unpacked to a temporary directory and Serious Python plugin will try to run `main.py` in the root of the archive. Current directory is changed to a temporary directory.
 
 If your Python app has a different entry point it could be specified with `appFileName` parameter:
 
 ```dart
-SeriousPython().run("app/app.zip", appFileName: "my_app.py");
+SeriousPython.run("app/app.zip", appFileName: "my_app.py");
 ```
 
 You can pass a map with environment variables that should be available in your Python program:
 
 ```dart
-SeriousPython().run("app/app.zip",
+SeriousPython.run("app/app.zip",
     appFileName: "my_app.py",
     environmentVariables: {"a": "1", "b": "2"});
 ```
 
 By default, Serious Python expects Python dependencies installed into `__pypackages__` directory in the root of app directory. You can add additional paths to look for 3rd-party packages using `modulePaths` parameter:
 
 ```dart
-SeriousPython().run("app/app.zip",
+SeriousPython.run("app/app.zip",
     appFileName: "my_app.py",
     modulePaths: ["/absolute/path/to/my/site-packages"]);
 ```
@@ -99,9 +99,9 @@ Make sure generated asset is added to `pubspec.yaml`.
 
 By default, embedded Python program is run in a separate thread, to avoid UI blocking. Your Flutter app is not supposed to directly call Python functions or modules, but instead it should communicate via some API provided by a Python app, such as: REST API, sockets, SQLite database, files, etc.
 
-To constantly run on background a Python program must be blocking, for example a [Flask app](examples/flask_example) listening on `8000` port, or you can start your long-running computations in `threading.Thread` and use `threading.Event` to prevent program from exiting.
+To constantly run on background a Python program must be blocking, for example a [Flask app](example/flask_example) listening on `8000` port, or you can start your long-running computations in `threading.Thread` and use `threading.Event` to prevent program from exiting.
 
-Synchronous execution of Python program is also supported with `sync: true` parameter to `SeriousPython().run()` method. For example, it could be a utility program doing some preperations, etc. Just make sure it's either very short or run in a Dart isolate to avoid blocking UI.
+Synchronous execution of Python program is also supported with `sync: true` parameter to `SeriousPython.run()` method. For example, it could be a utility program doing some preperations, etc. Just make sure it's either very short or run in a Dart isolate to avoid blocking UI.
 
 ## Supported Python packages
 
@@ -117,7 +117,9 @@ TBD
 
 ## Examples
 
-[Python REPL with Flask backend](examples/flask_example).
+[Python REPL with Flask backend](example/flask_example).
+
+[Flet app](example/flet_example).
 
 ## Future plans
 

bin/package_command.dart

@@ -14,6 +14,8 @@ class PackageCommand extends Command {
   final description = "Packages Python app to Flutter assets.";
 
   PackageCommand() {
+    argParser.addFlag("pre",
+        help: "Install pre-release dependencies.", negatable: false);
     argParser.addOption('asset',
         abbr: 'a',
         help:
@@ -105,6 +107,12 @@ class PackageCommand extends Command {
             .map((d) => d.replaceAllMapped(RegExp(r'flet(\W{1,}|$)'),
                 (match) => 'flet-embed${match.group(1)}'))
             .toList();
+
+        List<String> extraArgs = [];
+        if (argResults?["pre"]) {
+          extraArgs.add("--pre");
+        }
+
         final pipProcess = await Process.start(
             'python3',
             [
@@ -113,6 +121,7 @@ class PackageCommand extends Command {
               'install',
               '--isolated',
               '--upgrade',
+              ...extraArgs,
               '--target',
               path.join(tempDir.path, '__pypackages__'),
               ...dependencies

example/README.md

@@ -0,0 +1,13 @@
+# Examples
+
+### Python REPL with Flask backend
+
+An exampe of using Flask to host app backend API written in Python.
+
+[Source](flask_example)
+
+### Flet app
+
+An example of integrating [Flet widget](https://pub.dev/packages/flet) and [Flet framework](https://pypi.org/project/flet/) to easily create awesome Flutter apps in Python.
+
+[Source](flet_example)

example/flask_example/ios/Podfile.lock

@@ -22,7 +22,7 @@ EXTERNAL SOURCES:
 SPEC CHECKSUMS:
   Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854
   path_provider_foundation: eaf5b3e458fc0e5fbb9940fb09980e853fe058b8
-  serious_python: 8b5a9a84f9095a4a6d41fe906ed34611681e44b6
+  serious_python: 954ab1502631a446dd28e0bacdb519e8a803a1fe
 
 PODFILE CHECKSUM: 7be2f5f74864d463a8ad433546ed1de7e0f29aef
 

example/flask_example/lib/main.dart

@@ -10,8 +10,7 @@ void main() {
 }
 
 void startPython() async {
-  SeriousPython()
-      .run("app/app.zip", environmentVariables: {"a": "1", "b": "2"});
+  SeriousPython.run("app/app.zip", environmentVariables: {"a": "1", "b": "2"});
 }
 
 class MyApp extends StatefulWidget {

example/flask_example/pubspec.lock

@@ -281,7 +281,7 @@ packages:
       path: "../.."
       relative: true
     source: path
-    version: "0.1.0"
+    version: "0.1.1"
   sky_engine:
     dependency: transitive
     description: flutter

example/flet_example/.gitignore

@@ -0,0 +1,44 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+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
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# 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

example/flet_example/.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.
+
+version:
+  revision: f92f44110e87bad5ff168335c36da6f6053036e6
+  channel: stable
+
+project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: f92f44110e87bad5ff168335c36da6f6053036e6
+      base_revision: f92f44110e87bad5ff168335c36da6f6053036e6
+    - platform: ios
+      create_revision: f92f44110e87bad5ff168335c36da6f6053036e6
+      base_revision: f92f44110e87bad5ff168335c36da6f6053036e6
+
+  # 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'

example/flet_example/README.md

@@ -0,0 +1,16 @@
+# flet_example
+
+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:
+
+- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
+- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+
+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.