Contents Menu Expand Light mode Dark mode Auto light/dark mode
gtrending 0.5.1
gtrending 0.5.1
  • Documentation Home
  • Fetch Module
    • Trending Repositories
    • Trending Developers
  • Utilities
  • API Reference
    • fetch
    • paramutils
Back to top
Edit this page

Trending Developers#

The fetch_developers() function can be used for fetching trending developers.

A list of dictionaries containing metadata about the trending developers as well as the repository they are trending for is returned.

Parameters#

  • language (str) - the programming language to search for (eg: python)

  • since (str) - the date range for the search period. Either one of: daily, weekly, or monthly

  • sponsorable (bool) - whether to only search for users with a sponsor URL

Note

All parameters are case-insensitive

The default arguments are:

  • language = "" (all languages included)

  • since = "daily"

  • sponsorable = False

The following are all valid examples:

# Any language, trending today
fetch_developers()

# Python, trending today
fetch_developers("python")

# Any language, trending this week
fetch_developers(since="weekly")

# Rust, trending this month
fetch_developers("rust", "monthly")

# C++, with sponsor URLs
fetch_developers("c++", sponsorable=True)

Example return values#

>>> fetch_developers()
[
  {
    "username": "stedolan",
    "name": "Stephen Dolan",
    "url": "https://github.com/stedolan",
    "sponsorUrl": None,
    "avatar": "https://avatars.githubusercontent.com/u/79765",
    "repo": {
      "name": "jq",
      "description": "Command-line JSON processor",
      "url": "https://github.com/stedolan/jq",
      "descriptionUrl": "https://jqlang.github.io/jq/"
    }
  },
  {
    "username": "wcandillon",
    "name": "William Candillon",
    "url": "https://github.com/wcandillon",
    "sponsorUrl": None,
    "avatar": "https://avatars.githubusercontent.com/u/306134",
    "repo": {
      "name": "can-it-be-done-in-react-native",
      "description": "\u269b\ufe0f \ud83d\udcfa Projects from the \u201cCan it be done in React Native?\u201d YouTube series",
      "url": "https://github.com/wcandillon/can-it-be-done-in-react-native",
      "descriptionUrl": "https://www.youtube.com/wcandillon"
    }
  },
  ...
]

Argument validation#

The language parameter raises ValueError for invalid language values or non-existent languages.

Likewise, since and sponsorable arguments raise ValueErrors for invalid types or invalid arguments.

Language#

Valid values must be one of the list of languages, returned from languages_params().

To check if a value is valid before passing to fetch_developers(), use check_language(language)

>>> check_language("python")
True
>>> check_language("Ruby")
True
>>> check_language("TeaScript")  # Does not exist
False
>>> check_language("")
False

See the ParamUtils module for usage details on parameter validation functions such as conversion between language argument formats, and validating language arguments.

Next
Utilities
Previous
Trending Repositories
Copyright © 2020-2023 hedyhli
Made with Sphinx and @pradyunsg's Furo
On this page
  • Trending Developers
    • Parameters
    • Example return values
    • Argument validation
      • Language