{"id":16167109,"url":"https://github.com/timroes/explain-plz","last_synced_at":"2025-11-12T22:00:41.488Z","repository":{"id":7359460,"uuid":"8684329","full_name":"timroes/explain-plz","owner":"timroes","description":"A small python tool, that explains you the android source code. See the README for more details.","archived":false,"fork":false,"pushed_at":"2013-03-10T22:41:53.000Z","size":120,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-07T05:49:46.910Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timroes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-10T11:35:25.000Z","updated_at":"2014-09-09T09:10:05.000Z","dependencies_parsed_at":"2022-09-22T13:02:27.849Z","dependency_job_id":null,"html_url":"https://github.com/timroes/explain-plz","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/timroes/explain-plz","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timroes%2Fexplain-plz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timroes%2Fexplain-plz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timroes%2Fexplain-plz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timroes%2Fexplain-plz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timroes","download_url":"https://codeload.github.com/timroes/explain-plz/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timroes%2Fexplain-plz/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":284115869,"owners_count":26949957,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-12T02:00:06.336Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T03:06:07.517Z","updated_at":"2025-11-12T22:00:40.617Z","avatar_url":"https://github.com/timroes.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"explain-plz\n===========\n\nThis is a small python tool (required Python 2.7+), that explains you the Android\nsource code. To use it, just put the `explain-plz` file anywhere to your $PATH.\n\nTo explain the android source code manually created explanations are used.\nThese explanation can be found in the [explain-plz-data](https://github.com/timroes/explain-plz-data) project.\nIf you can add usefull data, please edit the data and send pull request to that \nproject (more information can be found in its own README file).\n\nTo start the first time, you need to call `explain-plz --update` to update your\nlocal database. From that on you can use the tool:\n\n\nUsage\n-----\n\nTo use the tool just call `explain-plz` while you are in any directory of your \nAndroid source code (see the [AOSP instuctions](http://source.android.com/source/initializing.html) for\ninformation on how to get the Android source code).\n\nThe tool will then search the nearest parent directory, that it has an explanation\nfor and output that explanation. If you want another directory (than the current working\ndirectory) explained, just add this as first parameter (e.g. `explain-plz tools/buils`).\n\n\nParameters\n----------\n\nInstead of just explaining a folder you have the following parameters:\n\n**--help or -h** Shows a usage message with all the parameters.\n\n**--update or -u** Updates the local database from the above mentioned project.\n\n**--search {term} or -s {term}** Searches all explanation files for *{term}*.\n\n**--list or -l** Prints out a list of all folder, that can be explained by the tool.\n\n\nBugs\n----\n\nIf you find any bugs in the tool itself please report them via the GitHub issue tracker.\nIf you find any wrong information in the database or want to add some project or modify\nexplanation, please go to https://github.com/timroes/explain-plz-data\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimroes%2Fexplain-plz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimroes%2Fexplain-plz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimroes%2Fexplain-plz/lists"}