gitpython-developers
diff --git a/‎doc/source/quickstart.rst‎
Lines changed: 63 additions & 59 deletions b/‎doc/source/quickstart.rst‎
Lines changed: 63 additions & 59 deletions
diff --git a/‎test/test_quick_doc.py‎
Lines changed: 24 additions & 3 deletions b/‎test/test_quick_doc.py‎
Lines changed: 24 additions & 3 deletions
@@ -10,6 +10,41 @@ GitPython Quick Start Tutorial
 Welcome to the GitPython Quickstart Guide! Designed for developers seeking a practical and interactive learning experience, this concise resource offers step-by-step code snippets to swiftly initialize/clone repositories, perform essential Git operations, and explore GitPython's capabilities. Get ready to dive in, experiment, and unleash the power of GitPython in your projects!
 
 
+git.Repo
+********
+
+There are a few ways to create a :class:`git.Repo <git.repo.base.Repo>` object
+
+Initialize a new git Repo
+#########################
+
+.. literalinclude:: ../../test/test_quick_doc.py
+    :language: python
+    :dedent: 8
+    :start-after: # [1-test_init_repo_object]
+    :end-before: # ![1-test_init_repo_object]
+
+Existing local git Repo
+#######################
+
+.. literalinclude:: ../../test/test_quick_doc.py
+    :language: python
+    :dedent: 8
+    :start-after: # [2-test_init_repo_object]
+    :end-before: # ![2-test_init_repo_object]
+
+Clone from URL
+##############
+
+For the rest of this tutorial we will use a clone from https://github.com/gitpython-developers/QuickStartTutorialFiles.git
+
+.. literalinclude:: ../../test/test_quick_doc.py
+    :language: python
+    :dedent: 8
+    :start-after: # [1-test_cloned_repo_object]
+    :end-before: # ![1-test_cloned_repo_object]
+
+
 Trees & Blobs
 **************
 
@@ -40,6 +75,12 @@ Display level 1 Contents
         :start-after: # [14-test_cloned_repo_object]
         :end-before: # ![14-test_cloned_repo_object]
 
+.. literalinclude:: ../../test/test_quick_doc.py
+        :language: python
+        :dedent: 8
+        :start-after: # [14.1-test_cloned_repo_object]
+        :end-before: # ![14.1-test_cloned_repo_object]
+
 Recurse through the Tree
 ########################
 
@@ -58,67 +99,10 @@ Recurse through the Tree
 
 
 
-Printing text files
-####################
-
-.. literalinclude:: ../../test/test_quick_doc.py
-        :language: python
-        :dedent: 8
-        :start-after: # [17-test_cloned_repo_object]
-        :end-before: # ![17-test_cloned_repo_object]
-
-.. literalinclude:: ../../test/test_quick_doc.py
-        :language: python
-        :dedent: 8
-        :start-after: # [18-test_cloned_repo_object]
-        :end-before: # ![18-test_cloned_repo_object]
-
-
-
-
-
-git.Repo
-********
-
-There are a few ways to create a :class:`git.Repo <git.repo.base.Repo>` object
-
-An existing local path
-######################
-
-$ git init path/to/dir
-
-.. literalinclude:: ../../test/test_quick_doc.py
-    :language: python
-    :dedent: 8
-    :start-after: # [1-test_init_repo_object]
-    :end-before: # ![1-test_init_repo_object]
-
-Existing local git Repo
-#######################
-
-.. literalinclude:: ../../test/test_quick_doc.py
-    :language: python
-    :dedent: 8
-    :start-after: # [2-test_init_repo_object]
-    :end-before: # ![2-test_init_repo_object]
-
-Clone from URL
-##############
-
-For the rest of this tutorial we will use a clone from https://github.com/gitpython-developers/QuickStartTutorialFiles.git
-
-$ git clone https://github.com/gitpython-developers/QuickStartTutorialFiles.git
-
-.. literalinclude:: ../../test/test_quick_doc.py
-    :language: python
-    :dedent: 8
-    :start-after: # [1-test_cloned_repo_object]
-    :end-before: # ![1-test_cloned_repo_object]
-
 Usage
 ****************
 
-* $ git add filepath
+* $ git add <filepath>
 
 .. literalinclude:: ../../test/test_quick_doc.py
     :language: python
@@ -146,7 +130,7 @@ Warning: If you experience any trouble with this, try to invoke :class:`git <git
     :start-after: # [4-test_cloned_repo_object]
     :end-before: # ![4-test_cloned_repo_object]
 
-* $ git log file
+* $ git log <file>
 
 A list of commits associated with a file
 
@@ -166,6 +150,24 @@ Notice this returns a generator object
 
 returns list of :class:`Commit <git.objects.commit.Commit>` objects
 
+Printing text files
+####################
+Lets print the latest version of `<local_dir> dir1/file2.txt`
+
+.. literalinclude:: ../../test/test_quick_doc.py
+        :language: python
+        :dedent: 8
+        :start-after: # [17-test_cloned_repo_object]
+        :end-before: # ![17-test_cloned_repo_object]
+
+.. literalinclude:: ../../test/test_quick_doc.py
+        :language: python
+        :dedent: 8
+        :start-after: # [18-test_cloned_repo_object]
+        :end-before: # ![18-test_cloned_repo_object]
+
+Previous version of `<local_dir>/dir1/file2.txt`
+
 * $ git status
 
     * Untracked files
@@ -207,3 +209,5 @@ returns list of :class:`Commit <git.objects.commit.Commit>` objects
         :end-before: # ![11-test_cloned_repo_object]
 
 
+
+
@@ -15,6 +15,8 @@ def tearDown(self):
     def test_init_repo_object(self, path_to_dir):
 
         # [1-test_init_repo_object]
+        # $ git init <path/to/dir>
+
         from git import Repo
 
         repo = Repo.init(path_to_dir)  # git init path/to/dir
@@ -31,6 +33,8 @@ def test_cloned_repo_object(self, local_dir):
         import git
         # code to clone from url
         # [1-test_cloned_repo_object]
+        # $ git clone <url> <local_dir>
+
         repo_url = "https://github.com/gitpython-developers/QuickStartTutorialFiles.git"
 
         repo = Repo.clone_from(repo_url, local_dir)
@@ -128,12 +132,22 @@ def test_cloned_repo_object(self, local_dir):
         files_and_dirs
 
         # Output
-        # [<git.Commit "SHA1-HEX_HASH-2">,
-        # <git.Commit "SHA1-HEX_HASH-2">,
-        # <git.Commit "SHA1-HEX_HASH-2">]
+        # [<git.Commit "SHA1-HEX_HASH">,
+        # <git.Commit "SHA1-HEX_HASH">,
+        # <git.Commit "SHA1-HEX_HASH">]
 
         # ![14-test_cloned_repo_object]
 
+        # [14.1-test_cloned_repo_object]
+        files_and_dirs = [(entry, entry.name) for entry in tree]
+        files_and_dirs
+
+        # Output
+        # [(< git.Tree "SHA1-HEX_HASH" >, 'Downloads', 'tree'),
+        #  (< git.Tree "SHA1-HEX_HASH" >, 'dir1', 'tree'),
+        #  (< git.Blob "SHA1-HEX_HASH" >, 'file4.txt', 'blob')]
+        # ![14.1-test_cloned_repo_object]
+
         # [15-test_cloned_repo_object]
         def print_files_from_git(root, level=0):
             for entry in root:
@@ -163,6 +177,13 @@ def print_files_from_git(root, level=0):
         # Output <git.Blob "SHA1-HEX-HASH-1">
         # ![17-test_cloned_repo_object]
 
+        # print pre
+        # [17.1-test_cloned_repo_object]
+        commits_for_file = [c for c in repo.iter_commits(all=True, paths=print_file)]
+        blob = tree[print_file]
+
+        # ![17.1-test_cloned_repo_object]
+
         # [18-test_cloned_repo_object]
         blob = tree[print_file]
         print(blob.data_stream.read().decode())