Skip to content

Instantly share code, notes, and snippets.

Avatar
:octocat:
doing open source

esc esc

:octocat:
doing open source
View GitHub Profile
@esc
esc / reference.md
Created Mar 29, 2013 — forked from cholin/pygit2 api reference
pygit2 api reference
View reference.md

Basic API (low-level)

  • public libgit2 structs should be python objects (classes) - Example: git_repository => Repository()
  • nameing convention: strip git_struct_name_* - Example: git_repository_config() => Repository.config()
  • iterations should be implemented as a generator, if this is not possible we need to change libgit2 (other bindings will benefit from this as well)
  • every method should map to one libgit2 function (exceptions are iterations)
  • return values of methods
    • no lists use generators instead
    • no dictionaries use tuples or objects instead
  • no instantiation of objects use strings instead (important for generators)