cf2703998e
Now that it has the features of the old implementation, let's add documentation on how to use it.
2.4 KiB
Remotes
pygit2.Repository.remotes
pygit2.Repository.create_remote
The Remote type
pygit2.Remote.name
pygit2.Remote.url
pygit2.Remote.push_url
pygit2.Remote.refspec_count
pygit2.Remote.push_refspecs
pygit2.Remote.fetch_refspecs
pygit2.Remote.progress
pygit2.Remote.transfer_progress
pygit2.Remote.update_tips
pygit2.Remote.get_refspec
pygit2.Remote.fetch
pygit2.Remote.push
pygit2.Remote.save
pygit2.Remote.add_push
pygit2.Remote.add_fetch
The TransferProgress type
This class contains the data which is available to us during a fetch.
pygit2.TransferProgress.total_objects
pygit2.TransferProgress.indexed_objects
pygit2.TransferProgress.received_objects
pygit2.TransferProgress.local_objects
pygit2.TransferProgress.total_deltas
pygit2.TransferProgress.indexed_deltas
pygit2.TransferProgress.received_bytes
The Refspec type
pygit2.Refspec.direction
pygit2.Refspec.src
pygit2.Refspec.dst
pygit2.Refspec.force
pygit2.Refspec.string
pygit2.Refspec.src_matches
pygit2.Refspec.dst_matches
pygit2.Refspec.transform
pygit2.Refspec.rtransform
Credentials
pygit2.Remote.credentials
There are two types of credentials: username/password and SSH key
pairs. Both :pypygit2.UserPass and :pypygit2.Keypair are callable
objects, with the appropriate signature for the credentials callback.
They will ignore all the arguments and return themselves. This is useful
for scripts where the credentials are known ahead of time. More complete
interfaces would want to look up in their keychain or ask the user for
the data to use in the credentials.
pygit2.UserPass
pygit2.Keypair