tentacles.search — irresponsible/tentacles 0.6.8

Implements the Github Search API: http://developer.github.com/v3/search/

search-code clj

(search-code keywords & [query options])

Finds file contents via various criteria. This method returns up to 100 results per page.

Parameters are: keywords - The search keywords. Can be string or sequence of strings. query - The search qualifiers. Query param is a map that contains qualifier values where key is a qualifier name.

The query map can contain any combination of the supported code search qualifiers. See full list in: https://developer.github.com/v3/search/#search-code

Sort and order fields are available via the options map.

This method follows API v3 pagination rules. More details about pagination rules in: https://developer.github.com/v3/#pagination

Returns map with the following elements: :total_count - The total number of found items. :incomplete_results - true if query exceeds the time limit. :items - The result vector of found items.

Example: (search-code "addClass" {:in "file" :language "js" :repo "jquery/jquery"})

This corresponds to the following search term: https://api.github.com/search/code?q=addClass+in:file+language:js+repo:jquery/jquery

search-issues clj

(search-issues keywords & [query options])

Finds issues by state and keyword. This method returns up to 100 results per page.

Parameters are: keywords - The search keywords. Can be string or sequence of strings. query - The search qualifiers. Query is a map that contains qualifier values where key is a qualifier name.

The query map can contain any combination of the supported issue search qualifiers. See full list in: https://developer.github.com/v3/search/#search-issues

Sort and order fields are available via the options map.

This method follows API v3 pagination rules. More details about pagination rules in: https://developer.github.com/v3/#pagination

Returns map with the following elements: :total_count - The total number of found items. :incomplete_results - true if query exceeds the time limit. :items - The result vector of found items.

Example: (search-issues "windows" {:label "bug" :language "python" :state "open"} {:sort "created" :order "asc"})

This corresponds to the following search term: https://api.github.com/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc

search-repos clj

(search-repos keywords & [query options])

Finds repositories via various criteria. This method returns up to 100 results per page.

Parameters are: keywords - The search keywords. Can be string or sequence of strings. query - The search qualifiers. Query is a map that contains qualifier values where key is a qualifier name.

The query map can contain any combination of the supported repository search qualifiers. See full list in: https://developer.github.com/v3/search/#search-repositories

Sort and order fields are available via the options map.

This method follows API v3 pagination rules. More details about pagination rules in: https://developer.github.com/v3/#pagination

Returns map with the following elements: :total_count - The total number of found items. :incomplete_results - true if query exceeds the time limit. :items - The result vector of found items.

Example: (search-repos "tetris" {:language "assembly"} {:sort "stars" :order "desc"})

This corresponds to the following search term: https://api.github.com/search/repositories?q=tetris+language:assembly&sort=stars&order=desc

search-term clj

(search-term keywords & [query])

Builds search term based on keywords and qualifiers.

search-topics clj

(search-topics keywords & [query options])

Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page.

When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

Parameters are: keywords - The search keywords. Can be string or sequence of strings. query - The search qualifiers. Query is a map that contains qualifier values where key is a qualifier name.

search-users clj

(search-users keywords & [query options])

Finds users via various criteria. This method returns up to 100 results per page.

Parameters are: keywords - The search keywords. Can be string or sequence of strings. query - The search qualifiers. Query is a map that contains qualifier values where key is a qualifier name.

The query map can contain any combination of the supported user search qualifiers. See full list in: https://developer.github.com/v3/search/#search-users

Sort and order fields are available via the options map.

This method follows API v3 pagination rules. More details about pagination rules in: https://developer.github.com/v3/#pagination

Returns map with the following elements: :total_count - The total number of found items. :incomplete_results - true if query exceeds the time limit. :items - The result vector of found items.

Example: (search-users "tom" {:repos ">42" :followers ">1000"})

This corresponds to the following search term: https://api.github.com/search/users?q=tom+repos:%3E42+followers:%3E1000