From 8f4f40ecbea6763bdd2a7a2575dc9d1fbe871a1c Mon Sep 17 00:00:00 2001 From: Vishal Sodani Date: Mon, 8 Oct 2018 09:01:25 +0530 Subject: [PATCH] Add examples for searching repositories (#874) (#918) --- doc/examples/MainClass.rst | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/doc/examples/MainClass.rst b/doc/examples/MainClass.rst index 98f99945..e232332b 100644 --- a/doc/examples/MainClass.rst +++ b/doc/examples/MainClass.rst @@ -37,4 +37,35 @@ Get organization by name >>> org = g.get_organization("PyGithub") >>> org.login - u'PyGithub' \ No newline at end of file + u'PyGithub' + +Search repositories by language +------------------------------- + +.. code-block:: python + + >>> repositories = g.search_repositories(query='language:python') + >>> for repo in repositories: + ... print(repo) + ... + Repository(full_name="vinta/awesome-python") + Repository(full_name="donnemartin/system-design-primer") + Repository(full_name="toddmotto/public-apis") + Repository(full_name="rg3/youtube-dl") + Repository(full_name="tensorflow/models") + Repository(full_name="django/django") + +Search repositories based on number of issues with good-first-issue +------------------------------------------------------------------- + +.. code-block:: python + + >>> repositories = g.search_repositories(query='good-first-issues:>3') + >>> for repo in repositories: + ... print(repo) + ... + Repository(full_name="vuejs/vue") + Repository(full_name="facebook/react") + Repository(full_name="facebook/react-native") + Repository(full_name="electron/electron") + Repository(full_name="Microsoft/vscode")