{"id":25869962,"url":"https://github.com/melevir/opensource_watchman","last_synced_at":"2025-08-12T09:05:41.815Z","repository":{"id":43237486,"uuid":"264022714","full_name":"Melevir/opensource_watchman","owner":"Melevir","description":"Opensource repos validator","archived":false,"fork":false,"pushed_at":"2023-05-22T23:26:55.000Z","size":133,"stargazers_count":5,"open_issues_count":10,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-06T06:49:09.209Z","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/Melevir.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":"2020-05-14T20:53:06.000Z","updated_at":"2022-06-29T08:32:59.000Z","dependencies_parsed_at":"2023-01-22T20:15:44.154Z","dependency_job_id":null,"html_url":"https://github.com/Melevir/opensource_watchman","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Melevir%2Fopensource_watchman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Melevir%2Fopensource_watchman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Melevir%2Fopensource_watchman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Melevir%2Fopensource_watchman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Melevir","download_url":"https://codeload.github.com/Melevir/opensource_watchman/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241464996,"owners_count":19967237,"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","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":"2025-03-02T05:29:20.634Z","updated_at":"2025-03-02T05:29:21.296Z","avatar_url":"https://github.com/Melevir.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# opensource_watchman\n\n[![Build Status](https://travis-ci.org/Melevir/opensource_watchman.svg?branch=master)](https://travis-ci.org/Melevir/opensource_watchman)\n[![Maintainability](https://api.codeclimate.com/v1/badges/56b0ffab734dad488a41/maintainability)](https://codeclimate.com/github/Melevir/opensource_watchman/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/56b0ffab734dad488a41/test_coverage)](https://codeclimate.com/github/Melevir/opensource_watchman/test_coverage)\n\nOpensource Github repos validator.\n\nThis tool checks project compliance with\n[BestDoctor opensource guide](https://github.com/best-doctor/guides/blob/master/guides/opensource_guide.md).\nIt check project data from Github, TravisCI, CodeClimate and PyPIstats and\nchecks if project matches all rules from the guide. The tool outputs data\nto console and can generate html report\n(like \u003chttps://opensource.bestdoctor.ru/\u003e). See \"Errors\" section of this\nreadme to see full list of possible errors.\n\n## Installation\n\n```terminal\npip install opensource_watchman\n```\n\n## Usage\n\nCheck all repos in Github organization/user:\n\n```terminal\nopensource_watchman {github username or organisation}\n```\n\nCheck single repo:\n\n```terminal\nopensource_watchman {github username or organisation} --repo_name={repo_name}\n```\n\nRest of watchman parameters can be viewed with `opensource_watchman --help`.\n\nTo run watchman, some environment variables must be provided:\n\n- `GITHUB_USERNAME`. This is login to use api, not login to check.\n- `GITHUB_API_TOKEN`. This should be create with account above.\n  [Instructions on how to get one.](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)\n- `TRAVIS_CI_ORG_ACCESS_TOKEN`.\n  [Can be generated from Github token.](https://docs.travis-ci.com/api/#with-a-github-token)\n- `CODECLIMATE_API_TOKEN`. Can be requested in\n  [tokens page in profile.](https://codeclimate.com/profile/tokens)\n\n## Example\n\n```terminal\n$ opensource_watchman/run.py Melevir --repo_name=opensource_watchman\nopensource_watchman\n    D02: None of following found in readme: installation\n    D02: None of following found in readme: contributing,contribution\n    D02: None of following found in readme: usage,example\n    R02: Package opensource_watchman is not released at PyPI\n    T03: Test coverage is too low (1.57\u003c80)\n```\n\n## Errors\n\n| code |                     Description                                    |\n|:----:|:------------------------------------------------------------------:|\n| D01  | {readme file name} not found                                       |\n| D02  | None of following found in readme: {missing readme sections}       |\n| C01  | {ci_config_file_name} not found                                    |\n| C02  | Current build status on Travis is not ok                           |\n| C03  | {required build command} found in build                            |\n| C04  | Travis badge not found in {readme_file_name}                       |\n| C05  | Travis weekly cron build is not enabled                            |\n| P01  | Travis build is not running on Python {required_python_version}    |\n| R01  | Package name not found at {package_name_path}                      |\n| R02  | Package {package_name} is not released at PyPI                     |\n| S01  | Last commit was at {last_commit_date}, more that 6 months ago      |\n| T01  | {owner}/{repo_name} not found at Codeclimate                       |\n| T02  | No test coverage info found for {owner}/{repo_name} at Codeclimate |\n| T03  | Test coverage is too low                                           |\n| T04  | Codeclimate test coverage badge not found at {readme_file_name}    |\n| I01  | Too few actual issues                                              |\n| M01  | Pull request #{pr_number} is stale for too long                    |\n\n## Contributing\n\nWe would love you to contribute to our project. It's simple:\n\n- Create an issue with bug you found or proposal you have.\n  Wait for approve from maintainer.\n- Create a pull request. Make sure all checks are green.\n- Fix review comments if any.\n- Be awesome.\n\nHere are useful tips:\n\n- You can run all checks and tests with `make check`. Please do it\n  before TravisCI does.\n- We use\n  [BestDoctor python styleguide](https://github.com/best-doctor/guides/blob/master/guides/en/python_styleguide.md).\n- We respect [Django CoC](https://www.djangoproject.com/conduct/).\n  Make soft, not bullshit.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelevir%2Fopensource_watchman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmelevir%2Fopensource_watchman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelevir%2Fopensource_watchman/lists"}