learnlog 0.7__tar.gz → 0.8__tar.gz

learnlog-0.8/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: learnlog
+Version: 0.8
+Summary: Automatic logging of student code development and test runs
+License-Expression: MIT
+License-File: LICENSE
+Author: Daniel Bosk
+Author-email: daniel@bosk.se
+Maintainer: Daniel Bosk
+Maintainer-email: dbosk@kth.se
+Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Education
+Requires-Dist: typer (>=0.9.0)
+Project-URL: Bug Tracker, https://github.com/dbosk/learnlog/issues
+Project-URL: Repository, https://github.com/dbosk/learnlog
+Description-Content-Type: text/markdown
+
+# learnlog
+
+A Python package that automatically logs code development and program runs.
+
+By adding `import learnlog` as the first import in a Python file, every
+program run is recorded transparently: source code changes, command-line
+arguments, standard input/output/error, and unhandled exceptions. The data is
+stored in a hidden local Git repository.
+
+## Use cases
+
+- **Sharing live-coding sessions.**
+  A teacher adds `import learnlog` to demonstration scripts during a lecture
+  or tutorial. After the session the teacher pushes the log to a remote
+  repository:
+
+  ```bash
+  learnlog set-remote git@gitlab.kth.se:dbosk/lecture01.git
+  learnlog push
+  ```
+
+  Students clone the log and replay it step by step:
+
+  ```bash
+  learnlog clone git@gitlab.kth.se:dbosk/lecture01.git
+  learnlog play
+  ```
+
+  Alternatively, when a shared Git remote is not available, the teacher can
+  export the log as a portable bundle file:
+
+  ```bash
+  learnlog export -o lecture01.bundle
+  ```
+
+  The teacher distributes the file (e.g. via a course page) and students
+  replay it directly:
+
+  ```bash
+  learnlog play lecture01.bundle
+  ```
+
+- **Studying how students code.**
+  A researcher creates an empty Git repository for each student. Each student
+  adds `import learnlog` to their programs and pushes the log:
+
+  ```bash
+  learnlog set-remote git@gitlab.kth.se:dbosk/alice-log.git
+  learnlog push
+  ```
+
+  The researcher then clones each student's repository to analyse the
+  development data:
+
+  ```bash
+  learnlog clone git@gitlab.kth.se:dbosk/alice-log.git
+  learnlog play
+  ```
+
+  Alternatively, the student can export the log as a bundle and submit it
+  through the course platform:
+
+  ```bash
+  learnlog export -o alice-log.bundle
+  ```
+
+  The researcher then replays it directly:
+
+  ```bash
+  learnlog play alice-log.bundle
+  ```
+
+  This gives a complete timeline of how students develop and debug their
+  code — for research purposes or to help students refine their debugging
+  techniques.
+

learnlog-0.8/README.md

@@ -0,0 +1,75 @@
+# learnlog
+
+A Python package that automatically logs code development and program runs.
+
+By adding `import learnlog` as the first import in a Python file, every
+program run is recorded transparently: source code changes, command-line
+arguments, standard input/output/error, and unhandled exceptions. The data is
+stored in a hidden local Git repository.
+
+## Use cases
+
+- **Sharing live-coding sessions.**
+  A teacher adds `import learnlog` to demonstration scripts during a lecture
+  or tutorial. After the session the teacher pushes the log to a remote
+  repository:
+
+  ```bash
+  learnlog set-remote git@gitlab.kth.se:dbosk/lecture01.git
+  learnlog push
+  ```
+
+  Students clone the log and replay it step by step:
+
+  ```bash
+  learnlog clone git@gitlab.kth.se:dbosk/lecture01.git
+  learnlog play
+  ```
+
+  Alternatively, when a shared Git remote is not available, the teacher can
+  export the log as a portable bundle file:
+
+  ```bash
+  learnlog export -o lecture01.bundle
+  ```
+
+  The teacher distributes the file (e.g. via a course page) and students
+  replay it directly:
+
+  ```bash
+  learnlog play lecture01.bundle
+  ```
+
+- **Studying how students code.**
+  A researcher creates an empty Git repository for each student. Each student
+  adds `import learnlog` to their programs and pushes the log:
+
+  ```bash
+  learnlog set-remote git@gitlab.kth.se:dbosk/alice-log.git
+  learnlog push
+  ```
+
+  The researcher then clones each student's repository to analyse the
+  development data:
+
+  ```bash
+  learnlog clone git@gitlab.kth.se:dbosk/alice-log.git
+  learnlog play
+  ```
+
+  Alternatively, the student can export the log as a bundle and submit it
+  through the course platform:
+
+  ```bash
+  learnlog export -o alice-log.bundle
+  ```
+
+  The researcher then replays it directly:
+
+  ```bash
+  learnlog play alice-log.bundle
+  ```
+
+  This gives a complete timeline of how students develop and debug their
+  code — for research purposes or to help students refine their debugging
+  techniques.

{learnlog-0.7 → learnlog-0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "learnlog"
-version = "0.7"
+version = "0.8"
 description = "Automatic logging of student code development and test runs"
 license = "MIT"
 readme = "README.md"

learnlog-0.7/PKG-INFO

@@ -1,42 +0,0 @@
-Metadata-Version: 2.4
-Name: learnlog
-Version: 0.7
-Summary: Automatic logging of student code development and test runs
-License-Expression: MIT
-License-File: LICENSE
-Author: Daniel Bosk
-Author-email: daniel@bosk.se
-Maintainer: Daniel Bosk
-Maintainer-email: dbosk@kth.se
-Requires-Python: >=3.9
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Education
-Classifier: Topic :: Education
-Requires-Dist: typer (>=0.9.0)
-Project-URL: Bug Tracker, https://github.com/dbosk/learnlog/issues
-Project-URL: Repository, https://github.com/dbosk/learnlog
-Description-Content-Type: text/markdown
-
-# learnlog
-
-A Python package that automatically logs code development and program runs.
-
-By adding `import learnlog` as the first import in a Python file, every
-program run is recorded transparently: source code changes, command-line
-arguments, standard input/output/error, and unhandled exceptions. The data is
-stored in a hidden local Git repository.
-
-## Use cases
-
-- **Studying how students code.**
-  Have students add `import learnlog` to their programs. The teacher can then
-  study students' development process — for research purposes or to help
-  students refine their debugging techniques.
-
-- **Sharing live-coding sessions.**
-  A teacher adds `import learnlog` to demonstration scripts during a lecture
-  or tutorial. After the session, run `learnlog export` to create a portable
-  bundle that students can replay step by step with `learnlog play`.
-

learnlog-0.7/README.md

@@ -1,20 +0,0 @@
-# learnlog
-
-A Python package that automatically logs code development and program runs.
-
-By adding `import learnlog` as the first import in a Python file, every
-program run is recorded transparently: source code changes, command-line
-arguments, standard input/output/error, and unhandled exceptions. The data is
-stored in a hidden local Git repository.
-
-## Use cases
-
-- **Studying how students code.**
-  Have students add `import learnlog` to their programs. The teacher can then
-  study students' development process — for research purposes or to help
-  students refine their debugging techniques.
-
-- **Sharing live-coding sessions.**
-  A teacher adds `import learnlog` to demonstration scripts during a lecture
-  or tutorial. After the session, run `learnlog export` to create a portable
-  bundle that students can replay step by step with `learnlog play`.