a377b32b60
Even though I am aware that the comment lines in pygit2/__init__.py are longer than 79 characters, there's a reason for that. If I break them, they'll show poorly in the documentation, and in my opinion better docs trump the 80 char requirement. If you think it's still better to have less than 80 characters in the comments, I'll gladly resubmit the changes at the expense of the documentation.
1.8 KiB
1.8 KiB
The repository
Everything starts either by creating a new repository, or by opening an existing one.
Contents
Functions
pygit2.init_repository
Example:
>>> from pygit2 import init_repository
>>> repo = init_repository('test') # Creates a non-bare repository
>>> repo = init_repository('test', bare=True) # Creates a bare repositorypygit2.clone_repository
Example:
>>> from pygit2 import clone_repository
>>> repo_url = 'git://github.com/libgit2/pygit2.git'
>>> repo_path = '/path/to/create/repository'
>>> repo = clone_repository(repo_url, repo_path) # Clones a non-bare repository
>>> repo = clone_repository(repo_url, repo_path, bare=True) # Clones a bare repositorypygit2.discover_repository
The Repository class
The Repository constructor only takes one argument, the path of the repository to open.
Example:
>>> from pygit2 import Repository >>> repo = Repository('pygit2/.git')
The API of the Repository class is quite large. Since this
documentation is orgaized by features, the related bits are explained in
the related chapters, for instance the :pypygit2.Repository.checkout method are explained in
the Checkout section.
Below there are some general attributes and methods:
pygit2.Repository.path
pygit2.Repository.workdir
pygit2.Repository.is_bare
pygit2.Repository.is_empty
pygit2.Repository.read
pygit2.Repository.write