kids.vcs 0.0.1

Access core informations

You can get interesting information fron the git repository itself:

>>> print(r.toplevel)
/.../repos

>>> r.bare
False

>>> print(r.gitdir)
/.../repos/.git

Read git config

We can access the config thanks to:

>>> r.config
<...GitConfig...>

>>> print(r.config["core.filemode"])
true

Git commit access

We can access interesting information per commit, for the following we need actually to commit something:

>>> _ = wrap(r"""
...     cd repos
...     ## Adding first file
...     echo 'Hello' > a
...     git add a
...     git commit -m 'new: first commit' \
...         --author 'Bob <bob@example.com>' \
...         --date '2000-01-01 10:00:00'
...     git tag 0.0.1
...
...     ## Adding second file
...     echo 'Second file' > b
...     git add b
...
...     ## Notice there are no section here.
...     git commit -m 'added ``b``, what a summary !' \
...         --author 'Alice <alice@example.com>' \
...         --date '2000-01-02 11:00:00'
...     git tag 0.0.2
... """)

Now we can:

>>> r.commit("HEAD")
<GitCommit 'HEAD'>

And several informations are available:

>>> print(r.commit("HEAD").author_name)
Alice
>>> print(r.commit("master").subject)
added ``b``, what a summary !

You can access to all of these:

>>> from kids.vcs import GIT_FORMAT_KEYS

>>> print(", ".join(sorted(GIT_FORMAT_KEYS)))
author_date, author_date_timestamp, author_name, body,
committer_date_timestamp, committer_name, raw_body, sha1, subject

There’s a convienience attribute date also:

>>> print(r.commit("0.0.2").date)
2000-01-02

Tags

You can get the list of tags:

>>> r.tags
[<GitCommit ...'0.0.1'>, <GitCommit ...'0.0.2'>]

Logs

You can access all commits via:

>>> list(r.log())
[<GitCommit ...>, <GitCommit ...>]

and provide wich commit ancestry to include or to exclude (see git log):

>>> list(r.log(includes=["HEAD", ], excludes=["0.0.1", ]))
[<GitCommit ...>]

Push Request Guidelines

You can send any code. I’ll look at it and will integrate it myself in the code base and leave you as the author. This process can take time and it’ll take less time if you follow the following guidelines:

• check your code with PEP8 or pylint. Try to stick to 80 columns wide.

• separate your commits per smallest concern.

• each commit should pass the tests (to allow easy bisect)

• each functionality/bugfix commit should contain the code, tests, and doc.

• prior minor commit with typographic or code cosmetic changes are very welcome. These should be tagged in their commit summary with !minor.

• the commit message should follow gitchangelog rules (check the git log to get examples)

• if the commit fixes an issue or finished the implementation of a feature, please mention it in the summary.

If you have some questions about guidelines which is not answered here, please check the current git log, you might find previous commit that would show you how to deal with your issue.