Module Import alias Import alias Import alias TryExcept body ImportFrom alias handlers ExceptHandler type NameLoad body ImportFrom alias ImportFrom alias ImportFrom alias Assign NameStore Dict Str Str Str Str Str Str Str Str Str Str Str Str Str Str ClassDef bases NameLoad body FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad AttributeLoad NameLoad attr If NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Num Assign NameStore Call AttributeLoad NameLoad attr Num Assign NameStore Call NameLoad Dict Str NameLoad Assign NameStore BinOpMod Str TupleLoad NameLoad NameLoad TryExcept body Assign NameStore Call AttributeLoad NameLoad attr NameLoad keyword NameLoad Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str handlers ExceptHandler type NameLoad name NameStore body Pass If UnaryOpNot NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign TupleStore NameStore NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign NameStore Str Assign NameStore Call AttributeLoad NameLoad attr If CompareIn NameLoad NameLoad body Assign NameStore SubscriptLoad NameLoad Index NameLoad TryExcept body Assign NameStore Call AttributeLoad NameLoad attr Str handlers ExceptHandler type NameLoad name NameStore body Assign NameStore Call AttributeLoad NameLoad attr Str keyword Str Return Dict Str Str Str Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad NameLoad decorator_list decorator_list
N/A N/A re N/A os N/A base64 N/A N/A urllib.parse urlencode N/A N/A N/A ImportError N/A urllib urlencode json_api_client JSONApiClient downloaders.downloader_exception DownloaderException N/A _readme_formats N/A .md .mkd .mdown .markdown .textile .creole .rst markdown markdown markdown markdown textile creole rst ReadmeClient N/A JSONApiClient N/A readme_info N/A N/A self url N/A N/A N/A 
        Retrieve the readme and info about it

        :param url:
            The URL of the readme file

        :raises:
            DownloaderException: if there is an error downloading the readme
            ClientException: if there is an error parsing the response

        :return:
            A dict with the following keys:
              `filename`
              `format` - `markdown`, `textile`, `creole`, `rst` or `txt`
              `contents` - contents of the readme as str/unicode
         N/A contents None N/A github_match N/A N/A re match https://raw\.github(?:usercontent)?\.com/([^/]+/[^/]+)/([^/]+)/readme(\.(md|mkd|mdown|markdown|textile|creole|rst|txt))?$ url N/A re I N/A github_match N/A N/A user_repo N/A N/A github_match group 1 N/A branch N/A N/A github_match group 2 N/A query_string N/A urlencode N/A ref branch N/A readme_json_url N/A https://api.github.com/repos/%s/readme?%s N/A user_repo query_string N/A N/A N/A info N/A N/A self fetch_json readme_json_url prefer_cached True N/A contents N/A N/A base64 b64decode N/A info N/A content N/A N/A N/A ValueError N/A e N/A N/A N/A N/A contents N/A N/A contents N/A N/A self fetch url N/A N/A basename ext N/A N/A N/A os path splitext url N/A format txt N/A ext N/A N/A ext lower N/A N/A ext _readme_formats N/A N/A format N/A _readme_formats N/A ext N/A N/A N/A contents N/A N/A contents decode utf-8 N/A N/A N/A UnicodeDecodeError N/A e N/A N/A contents N/A N/A contents decode cp1252 errors replace N/A N/A filename format contents N/A N/A N/A os path basename url format contents N/A N/A