gitpython-developers
diff --git a/‎doc/source/quickstart.rst‎
Lines changed: 37 additions & 0 deletions b/‎doc/source/quickstart.rst‎
Lines changed: 37 additions & 0 deletions
diff --git a/‎test/test_quick_doc.py‎
Lines changed: 33 additions & 0 deletions b/‎test/test_quick_doc.py‎
Lines changed: 33 additions & 0 deletions
@@ -0,0 +1,37 @@
+.. _quickdoc_toplevel:
+
+.. highlight:: python
+
+.. _quickdoc-label:
+
+==============================
+GitPython Quick Start Tutorial
+==============================
+
+git.Repo
+********
+
+There are a few ways to create a :class:`git.Repo <git.repo.base.Repo>` object
+
+An existing local path
+######################
+
+.. 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
@@ -0,0 +1,33 @@
+import pytest
+
+import git
+from test.lib import TestBase
+from test.lib.helper import with_rw_directory
+
+
+class QuickDoc(TestBase):
+    def tearDown(self):
+        import gc
+
+        gc.collect()
+
+    @with_rw_directory
+    def test_init_repo_object(self, rw_dir):
+        path_to_dir = rw_dir
+
+        # [1-test_init_repo_object]
+        from git import Repo
+
+        repo = Repo.init(path_to_dir)
+        assert repo.__class__ is Repo # Test to confirm repo was initialized
+        # ![1-test_init_repo_object]
+
+        # [2-test_init_repo_object]
+        try:
+            repo = Repo(path_to_dir)
+        except git.NoSuchPathError:
+            assert False, f"No such path {path_to_dir}"
+        # ! [2-test_init_repo_object]
+
+        # [3 - test_init_repo_object]
+