{"id":19041170,"url":"https://github.com/ricardochaves/python-lint","last_synced_at":"2025-04-09T10:08:03.723Z","repository":{"id":52447014,"uuid":"225063024","full_name":"ricardochaves/python-lint","owner":"ricardochaves","description":"GitHub Action for Lint your code","archived":false,"fork":false,"pushed_at":"2024-01-04T11:32:02.000Z","size":25,"stargazers_count":92,"open_issues_count":8,"forks_count":41,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-22T03:26:17.019Z","etag":null,"topics":["black","flake8","github-actions","isort","mypy","pycodestyle","pylint"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ricardochaves.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-30T19:56:42.000Z","updated_at":"2024-07-02T06:34:58.000Z","dependencies_parsed_at":"2024-06-18T13:37:51.830Z","dependency_job_id":"8bbc7ff0-d415-42ed-9286-8c72443a47d5","html_url":"https://github.com/ricardochaves/python-lint","commit_stats":{"total_commits":40,"total_committers":1,"mean_commits":40.0,"dds":0.0,"last_synced_commit":"bc5d126b714bcc5bfd594641ca0954d58a311c0c"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardochaves%2Fpython-lint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardochaves%2Fpython-lint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardochaves%2Fpython-lint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardochaves%2Fpython-lint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ricardochaves","download_url":"https://codeload.github.com/ricardochaves/python-lint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248018060,"owners_count":21034048,"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":["black","flake8","github-actions","isort","mypy","pycodestyle","pylint"],"created_at":"2024-11-08T22:27:37.278Z","updated_at":"2025-04-09T10:08:03.698Z","avatar_url":"https://github.com/ricardochaves.png","language":"Shell","readme":"# python-lint\n\n\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://github.com/ricardochaves/python-lint\"\u003e\u003cimg alt=\"All lints status\" src=\"https://github.com/ricardochaves/python-lint/workflows/all-lints/badge.svg\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n## About\n\nThis action must be used for aplication the bids:\n\n- [black](https://github.com/psf/black)\n- [pylint](https://www.pylint.org/)\n- [isort](https://github.com/timothycrosley/isort)\n- [pycodestyle](https://pycodestyle.readthedocs.io)\n- [flake8](http://flake8.pycqa.org)\n- [mypy](http://mypy-lang.org/)\n\n## Usage\n\nSee [action.yml](action.yml)\n\nBasic:\n\n```yml\nsteps:\n  - uses: actions/checkout@v4\n  - uses: ricardochaves/python-lint@v1.4.0\n```\n\nOptions:\n\n```yml\nsteps:\n  - uses: actions/checkout@v4\n  - uses: ricardochaves/python-lint@v1.4.0\n    with:\n      python-root-list: \"python_alelo tests\"\n      use-pylint: false\n      use-pycodestyle: false\n      use-flake8: false\n      use-black: false\n      use-mypy: false\n      use-isort: false\n      extra-pylint-options: \"\"\n      extra-pycodestyle-options: \"\"\n      extra-flake8-options: \"\"\n      extra-black-options: \"\"\n      extra-mypy-options: \"\"\n      extra-isort-options: \"\"\n```\n\nCommand build logic list:\n\n```bash\npylint $(extra-pylint-options) $(python-root-list)\n\npycodestyle $(extra-pycodestyle-options) $(python-root-list)\n\nflake8 $(extra-flake8-options) $(python-root-list)\n\nblack --check $(extra-black-options) $(python-root-list)\n\nmypy $(extra-mypy-options) $(python-root-list)\n\nisort $(extra-isort-options) $(python-root-list) -c --diff\n```\n\n## Versions used\n\nTo identify the version used you must consult the [CHANGELOG.md](https://github.com/ricardochaves/python-lint-image/blob/master/CHANGELOG.md) of the image used in our [Dockerfile](https://github.com/ricardochaves/python-lint-image/blob/master/Dockerfile).\n\n## Test locally\n\nUse [act](https://github.com/nektos/act) to test the action locally.\nUnfortunately it still doesn't work on all OSs, if you can't use it try the solution below.\n\nSome libs may behave differently between OSs.\nThat's why this action runs on a docker image. This makes it possible for us to test some things locally.\n\nUsing `docker compose`, add the following service\n\n```yml\n  test-lint:\n    image: ricardobchaves6/python-lint-image:1.3.0\n    working_dir: /app\n    volumes:\n      - .:/app\n    command: [\"mypy\", \".\"]\n```\n\nUse the commands described in the section above. Choose the version of the image equivalent to the version of the action.\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n\n## Contributions\n\nContributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricardochaves%2Fpython-lint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fricardochaves%2Fpython-lint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricardochaves%2Fpython-lint/lists"}