gerritlib/doc/source/usage.rst

=====
Usage
=====

Example usage::

    import gerritlib.gerrit as gerrit
    g = gerrit.Gerrit('gerrit_host', 'username', keyfile='/home/username/.ssh/id_rsa.pub', keep_alive_interval=60)

    # manage projects
    g.createProject('test', description='a test project')
    projects = g.listProjects()
    print(projects)

    # manage groups
    g.createGroup('testers')
    groups = g.listGroups()
    print(groups)


Look at the :doc:`api` for more details.
Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f 2015-03-19 12:15:32 -07:00			`=====`
Doc generation support Based on cookiecutter and slightly tweaked afterward. * conf.py has autoclass_content = 'both' to generate the __init__ documentation. * bumped doc copyright to 2015. * adds in tox environement 'docs' as a convenience Change-Id: I69bb4179be343ab7c8a44f6fb80d5a428fe30e17 2014-05-22 15:24:28 +02:00			`Usage`
Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f 2015-03-19 12:15:32 -07:00			`=====`
Doc generation support Based on cookiecutter and slightly tweaked afterward. * conf.py has autoclass_content = 'both' to generate the __init__ documentation. * bumped doc copyright to 2015. * adds in tox environement 'docs' as a convenience Change-Id: I69bb4179be343ab7c8a44f6fb80d5a428fe30e17 2014-05-22 15:24:28 +02:00
Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f 2015-03-19 12:15:32 -07:00			`Example usage::`
Doc generation support Based on cookiecutter and slightly tweaked afterward. * conf.py has autoclass_content = 'both' to generate the __init__ documentation. * bumped doc copyright to 2015. * adds in tox environement 'docs' as a convenience Change-Id: I69bb4179be343ab7c8a44f6fb80d5a428fe30e17 2014-05-22 15:24:28 +02:00
Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f 2015-03-19 12:15:32 -07:00			`import gerritlib.gerrit as gerrit`
Add support for TCP keep alive in gerritlib Clients using gerritlib behind NAT/firewall can be stuck when the NAT/firewall discard packets belong to the TCP connection after extended silent periods thinking the connection is dead. This change allows clients using gerritlib to set keep alive interval to a non zero value. This will enable TCP keep alive packets to be sent in configured intervals keeping the TCP connections alive. Change-Id: I588706bb51ce41810cd2243f4969763d193d1d55 2020-09-09 17:22:29 -07:00			`g = gerrit.Gerrit('gerrit_host', 'username', keyfile='/home/username/.ssh/id_rsa.pub', keep_alive_interval=60)`
Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f 2015-03-19 12:15:32 -07:00
			`# manage projects`
			`g.createProject('test', description='a test project')`
			`projects = g.listProjects()`
			`print(projects)`

			`# manage groups`
			`g.createGroup('testers')`
			`groups = g.listGroups()`
			`print(groups)`


Add support for TCP keep alive in gerritlib Clients using gerritlib behind NAT/firewall can be stuck when the NAT/firewall discard packets belong to the TCP connection after extended silent periods thinking the connection is dead. This change allows clients using gerritlib to set keep alive interval to a non zero value. This will enable TCP keep alive packets to be sent in configured intervals keeping the TCP connections alive. Change-Id: I588706bb51ce41810cd2243f4969763d193d1d55 2020-09-09 17:22:29 -07:00			Look at the :doc:`api` for more details.