GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — WIP Quick doc by LeoDaCoda · Pull Request #1608 · gitpython-developers/GitPython

Conversation

@LeoDaCoda

@LeoDaCoda LeoDaCoda commented Jul 10, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

Hey, this PR is in reference to an issue I raised. I would like to add a quick start guide to act as another resource for developers, I planned the guide to be mainly code snippets as opposed to a text based tutorial.

I finished all the code and section headers I planned to add to the quick doc. I still want to add a few short sentences to improve readability. The tutorials includes how to do basic repo operations like init, clone, add, commit and push. Also shows how to iterate through the trees and print a text file.

Where possible I tried to follow the conventions the regular tutorial followed (ie having the code snippets inside of the test file) but in some cases I had to add code directly to the RST (I did this to avoid having unnecessary print statements to the test suite).

This is my first PR so forgive me if I did not follow propper conventions. Look forward to your feedback, Thanks!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
LeoDaCoda added 10 commits July 8, 2023 15:22
@LeoDaCoda
Made the init repo section of quickdoc
97cdb40
@LeoDaCoda
Added git clone & git add
6a9154b
@LeoDaCoda
Finishing touches for Repo quickstart
3c42bae
@LeoDaCoda
finished code for quickstart
10ea113
@LeoDaCoda
finished code for quickstart
b0da0a9
@LeoDaCoda
fixed some indentation
fb35ed1
@LeoDaCoda
Merge remote-tracking branch 'origin/quick_doc' into quick_doc
d42d82e
@LeoDaCoda
added quickstart to toctree and fixed sphinx warning
47c8362
@LeoDaCoda
added quickstart to toctree to fix sphinx warning
b7955ed
@LeoDaCoda
Merge remote-tracking branch 'origin/quick_doc' into quick_doc
4534f84
Byron
Byron requested changes Jul 10, 2023
View reviewed changes

@Byron Byron left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for taking the time to figure out how to contribute to the documentation setup used in GitPython, it's absolutely awesome to see it improve after all this time.

The goal of the quick-start section is to show code people can copy-paste and as such it should represent the best GitPython, and python, have to offer. Thus I may have a lot of opinions in the following comments, but those are merely to get closer to that (probably unattainable) goal.

Generally, please avoid assigning variables that are only used once unless they truly help to explain what the expression means, and names like fileX don't seem to do that.

Besides that, I think this is an excellent basis for getting this out to people fast. What would help me is if you could attach a PDF of the rendered document in the comments so I don't have to go through the trouble of building it locally (I have not been able to do anything with python for quite some time and it's great pain for me to deal with that again).

Looking forward to push this PR to an early completion, hoping that you can keep improving the document as you gain more insights into GitPython yourself.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread doc/source/quickstart.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/source/quickstart.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/source/quickstart.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/source/quickstart.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Outdated

# Previous commit tree
# [13-test_cloned_repo_object]
prev_commits = [c for c in repo.iter_commits('--all', max_count=10)]

@Byron Byron Jul 10, 2023

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't there a way to get the last result of an iterator without creating an intermediate array? If not, and it looks like it, please ignore and leave it.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

LeoDaCoda added 11 commits July 10, 2023 13:51
@LeoDaCoda
Removed code from RST
03d26f0
@LeoDaCoda
Made variable names more intuitive
a0045d8
@LeoDaCoda
Updated the sample repo URL
9833655
@LeoDaCoda
removed try/except and updated sample url
3cda530
@LeoDaCoda
correct way to get the latest commit tree
e4bbc7a
@LeoDaCoda
convert from --all flag to all=True
a1dfd4a
@LeoDaCoda
removed unnecessary variables
a8b5863
@LeoDaCoda
replaced output cell to generic commit ID
abe7e6e
@LeoDaCoda
replaced hash with generic
1369bdc
@LeoDaCoda
draft of description
9cd9431
@LeoDaCoda
clarified comment
393bae5
@LeoDaCoda

LeoDaCoda commented Jul 13, 2023

Copy link
Copy Markdown
Contributor Author

Sorry for the late response I was a little busy this week. I think I addressed all your comments and I attached the pdf output. I asked gpt to write a 1-2 sentence intro, but to me it still sounds a little wonky.

I intended the quickstart`s audience to be developers that want to just code/experiment and do not want to comb through the entire tutorial and stackoverflow posts. Do you think the tutorial is missing anything
Quickstar-print.pdf

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Byron
Byron reviewed Jul 13, 2023
View reviewed changes

@Byron Byron left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for making time and improving it to the point of "nearly there". The PDF was key to a much more pleasant review, thanks for that.

I have a left a couple of comments, but would additionally like you to check each sentence and make sure there is a period (.) terminating them. The remaining bullet-point-style sentences should also be changed to full sentences, for consistency. Now that I read through it, maybe it's easier to turn these sentences into bulletpoints, please make your choice.

Thanks again for your help.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread doc/source/quickstart.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/source/quickstart.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py
commits_for_file

# Outputs: [<git.Commit "SHA1-HEX-HASH-1">,
# <git.Commit "SHA1-HEX-HASH-1">]

@Byron Byron Jul 13, 2023

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be "SHA1-HEX_HASH-2".

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/source/quickstart.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

LeoDaCoda added 6 commits July 13, 2023 16:15
@LeoDaCoda
refactored print git tree
aa6d27f
@LeoDaCoda
Made trees and blobs the first section
6d78ff1
@LeoDaCoda
Added warning about index add
2c9c0c1
@LeoDaCoda
Updated generic sha hash
d276107
@LeoDaCoda
Removed all reference to source code
f3968f2
@LeoDaCoda
WIP major changes to structure to improve readability
9ca25d7
LeoDaCoda added 7 commits July 16, 2023 18:33
@LeoDaCoda
Added new section to print prev file
7fa57e5
@LeoDaCoda
change to formatting - removed = bash cmds
9d878af
@LeoDaCoda
formatting wip
315405d
@LeoDaCoda
added new section for diffs and formatting
bccf8bc
@LeoDaCoda
tabbed all code-blocks
cad1e2e
@LeoDaCoda
fixed tabbing
7e589f3
@LeoDaCoda
redundant line
2a45f94
@LeoDaCoda

LeoDaCoda commented Jul 18, 2023

Copy link
Copy Markdown
Contributor Author

Hey Byron! I made some changes to make the document more readable like putting the equivalent bash in a comment instead as a sub-header. I also some made general changes to the structure and the order of the code-snippets.

I attached the pdf print version.
Quickstar-print.pdf

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Byron
Byron requested changes Jul 18, 2023
View reviewed changes

@Byron Byron left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again! I have a feeling that not all of my comments have been applied (I am looking at you, . ;)), but with the structural changes it doesn't strike me as problem anymore.

Once you have applied the last remaining changes to unify the depiction of hashes, this PR is good to go. Note that the idea there was to not let it appear they are the same by adding an incremental number at their tail, so now I go for the smallest common denominator and remove the numbering instead so they are at least consistent.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/test_quick_doc.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

LeoDaCoda added 4 commits July 18, 2023 15:18
@LeoDaCoda
redundant code cell
ef4d6d5
@LeoDaCoda
generic hash
8138b3a
@LeoDaCoda
added more resources section
84885a3
@LeoDaCoda
typo
cf3a899
@LeoDaCoda

LeoDaCoda commented Jul 19, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

At first I didn't understand what you meant by the -1 and -2 but after you explained it it made more sense. I tried to follow this convention: blob and tree would not have an appended number, but commits would be numbered in chronological order.

I also wanted to link some sections of the full tutorial in the relevant sections of the quick start, but I ran into a problem. Sphinx requires references to follow this convention: :ref:'Remotes <handling-remotes-label>' where the label .. _handling-remotes-label: exists in some other RST document. Do you think its a good idea to add labels to the subsections of the full tutorial?
Quickstar-print.pdf

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Byron Byron added this to the v3.1.33 - Bugfixes milestone Jul 20, 2023
@Byron

Byron commented Jul 20, 2023

Copy link
Copy Markdown
Member

Great, thanks for all the fixes!

Regarding the subsection labels, feel free to add them in the next PR :). Let's get this merged!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Byron
Byron merged commit 09861ea into gitpython-developers:main Jul 20, 2023
renovate Bot referenced this pull request in allenporter/flux-local Sep 4, 2023
@renovate
Update dependency GitPython to v3.1.34 (#320)
6a0c4f9
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [GitPython](https://togithub.com/gitpython-developers/GitPython) |
`==3.1.32` -> `==3.1.34` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/GitPython/3.1.34?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/GitPython/3.1.34?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/GitPython/3.1.32/3.1.34?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/GitPython/3.1.32/3.1.34?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>gitpython-developers/GitPython (GitPython)</summary>

###
[`v3.1.34`](https://togithub.com/gitpython-developers/GitPython/releases/tag/3.1.34):
- fix resource leaking

[Compare
Source](https://togithub.com/gitpython-developers/GitPython/compare/3.1.33...3.1.34)

##### What's Changed

- util: close lockfile after opening successfully by
[@&#8203;skshetry](https://togithub.com/skshetry) in
[https://github.com/gitpython-developers/GitPython/pull/1639](https://togithub.com/gitpython-developers/GitPython/pull/1639)

##### New Contributors

- [@&#8203;skshetry](https://togithub.com/skshetry) made their first
contribution in
[https://github.com/gitpython-developers/GitPython/pull/1639](https://togithub.com/gitpython-developers/GitPython/pull/1639)

**Full Changelog**:
gitpython-developers/GitPython@3.1.33...3.1.34

###
[`v3.1.33`](https://togithub.com/gitpython-developers/GitPython/releases/tag/3.1.33):
- with security fix

[Compare
Source](https://togithub.com/gitpython-developers/GitPython/compare/3.1.32...3.1.33)

##### What's Changed

- WIP Quick doc by [@&#8203;LeoDaCoda](https://togithub.com/LeoDaCoda)
in
[https://github.com/gitpython-developers/GitPython/pull/1608](https://togithub.com/gitpython-developers/GitPython/pull/1608)
- Partial clean up wrt mypy and black by
[@&#8203;bodograumann](https://togithub.com/bodograumann) in
[https://github.com/gitpython-developers/GitPython/pull/1617](https://togithub.com/gitpython-developers/GitPython/pull/1617)
- Disable merge_includes in config writers by
[@&#8203;bodograumann](https://togithub.com/bodograumann) in
[https://github.com/gitpython-developers/GitPython/pull/1618](https://togithub.com/gitpython-developers/GitPython/pull/1618)
- feat: full typing for "progress" parameter in Repo class by
[@&#8203;madebylydia](https://togithub.com/madebylydia) in
[https://github.com/gitpython-developers/GitPython/pull/1634](https://togithub.com/gitpython-developers/GitPython/pull/1634)
- Fix CVE-2023-40590 by
[@&#8203;EliahKagan](https://togithub.com/EliahKagan) in
[https://github.com/gitpython-developers/GitPython/pull/1636](https://togithub.com/gitpython-developers/GitPython/pull/1636)
-
[#&#8203;1566](https://togithub.com/gitpython-developers/GitPython/issues/1566)
Creating a lock now uses python built-in "open()" method to work arou…
by [@&#8203;HageMaster3108](https://togithub.com/HageMaster3108) in
[https://github.com/gitpython-developers/GitPython/pull/1619](https://togithub.com/gitpython-developers/GitPython/pull/1619)

##### New Contributors

- [@&#8203;LeoDaCoda](https://togithub.com/LeoDaCoda) made their first
contribution in
[https://github.com/gitpython-developers/GitPython/pull/1608](https://togithub.com/gitpython-developers/GitPython/pull/1608)
- [@&#8203;bodograumann](https://togithub.com/bodograumann) made their
first contribution in
[https://github.com/gitpython-developers/GitPython/pull/1617](https://togithub.com/gitpython-developers/GitPython/pull/1617)
- [@&#8203;EliahKagan](https://togithub.com/EliahKagan) made their first
contribution in
[https://github.com/gitpython-developers/GitPython/pull/1636](https://togithub.com/gitpython-developers/GitPython/pull/1636)
- [@&#8203;HageMaster3108](https://togithub.com/HageMaster3108) made
their first contribution in
[https://github.com/gitpython-developers/GitPython/pull/1619](https://togithub.com/gitpython-developers/GitPython/pull/1619)

**Full Changelog**:
gitpython-developers/GitPython@3.1.32...3.1.33

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/allenporter/flux-local).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi43OC44IiwidXBkYXRlZEluVmVyIjoiMzYuNzguOCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
otc-zuul Bot pushed a commit to opentelekomcloud-infra/eyes_on_docs that referenced this pull request Sep 11, 2023
@dependabot
Bump gitpython from 3.1.32 to 3.1.35 (#32)
0eef04a
Bump gitpython from 3.1.32 to 3.1.35

Bumps gitpython from 3.1.32 to 3.1.35.

Release notes
Sourced from gitpython's releases.

3.1.35 - a fix for CVE-2023-41040
What's Changed

Bump actions/checkout from 3 to 4 by @​dependabot in gitpython-developers/GitPython#1643
Fix 'Tree' object has no attribute '_name' when submodule path is normal path by @​CosmosAtlas in gitpython-developers/GitPython#1645
Fix CVE-2023-41040 by @​facutuesca in gitpython-developers/GitPython#1644
Only make config more permissive in tests that need it by @​EliahKagan in gitpython-developers/GitPython#1648
Added test for PR #1645 submodule path by @​CosmosAtlas in gitpython-developers/GitPython#1647
Fix Windows environment variable upcasing bug by @​EliahKagan in gitpython-developers/GitPython#1650

New Contributors

@​CosmosAtlas made their first contribution in gitpython-developers/GitPython#1645
@​facutuesca made their first contribution in gitpython-developers/GitPython#1644

Full Changelog: gitpython-developers/[email protected]
3.1.34 - fix resource leaking
What's Changed

util: close lockfile after opening successfully by @​skshetry in gitpython-developers/GitPython#1639

New Contributors

@​skshetry made their first contribution in gitpython-developers/GitPython#1639

Full Changelog: gitpython-developers/[email protected]
v3.1.33 - with security fix
What's Changed

WIP Quick doc by @​LeoDaCoda in gitpython-developers/GitPython#1608
Partial clean up wrt mypy and black by @​bodograumann in gitpython-developers/GitPython#1617
Disable merge_includes in config writers by @​bodograumann in gitpython-developers/GitPython#1618
feat: full typing for "progress" parameter in Repo class by @​madebylydia in gitpython-developers/GitPython#1634
Fix CVE-2023-40590 by @​EliahKagan in gitpython-developers/GitPython#1636
#1566 Creating a lock now uses python built-in "open()" method to work arou… by @​HageMaster3108 in gitpython-developers/GitPython#1619

New Contributors

@​LeoDaCoda made their first contribution in gitpython-developers/GitPython#1608
@​bodograumann made their first contribution in gitpython-developers/GitPython#1617
@​EliahKagan made their first contribution in gitpython-developers/GitPython#1636
@​HageMaster3108 made their first contribution in gitpython-developers/GitPython#1619

Full Changelog: gitpython-developers/[email protected]



Commits

c8e303f prepare next release
09e1b3d Merge pull request #1650 from EliahKagan/envcase
8017421 Merge pull request #1647 from CosmosAtlas/master
fafb4f6 updated docs to better describe testing procedure with new repo
9da24d4 add test for submodule path not owned by submodule case
eebdb25 Eliminate duplication of git.util.cwd logic
c7fad20 Fix Windows env var upcasing regression
7296e5c Make test helper script a file, for readability
d88372a Add test for Windows env var upcasing regression
11839ab Merge pull request #1648 from EliahKagan/file-protocol
Additional commits viewable in compare view




Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the Security Alerts page.

Reviewed-by: Vladimir Vshivkov
@data-sync-user data-sync-user mentioned this pull request Feb 9, 2025
Bump gitpython from 3.1.32 to 3.1.37 mozilla/opmon#168
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Byron Byron Byron requested changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Milestone

v3.1.33 - Bugfixes

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@LeoDaCoda @Byron
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.