{"id":15712380,"url":"https://github.com/nickineering/ruff-config","last_synced_at":"2026-02-25T12:42:22.504Z","repository":{"id":229880927,"uuid":"777903174","full_name":"nickineering/ruff-config","owner":"nickineering","description":"A shareable Ruff starting config designed to get as much as possibly from Ruff quickly.","archived":false,"fork":false,"pushed_at":"2024-10-22T00:27:37.000Z","size":33,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-12T20:04:41.751Z","etag":null,"topics":["dotfiles","linting","python","ruff"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/nickineering-ruff-config/","language":"Python","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/nickineering.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2024-03-26T18:05:44.000Z","updated_at":"2025-02-20T00:08:24.000Z","dependencies_parsed_at":"2024-10-22T22:26:40.062Z","dependency_job_id":null,"html_url":"https://github.com/nickineering/ruff-config","commit_stats":null,"previous_names":["nickineering/ruff-config"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/nickineering/ruff-config","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickineering%2Fruff-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickineering%2Fruff-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickineering%2Fruff-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickineering%2Fruff-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nickineering","download_url":"https://codeload.github.com/nickineering/ruff-config/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickineering%2Fruff-config/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262432352,"owners_count":23310228,"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":["dotfiles","linting","python","ruff"],"created_at":"2024-10-03T21:15:55.985Z","updated_at":"2026-02-25T12:42:22.500Z","avatar_url":"https://github.com/nickineering.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nickineering's Default Ruff Config\n\n![PyPI - Version](https://img.shields.io/pypi/v/nickineering-ruff-config)\n\nA shareable Ruff starting config designed to get as much as possibly from Ruff\nquickly.\n\n## Usage\n\n```bash\npip install ruff nickineering-ruff-config\n```\n\nPip install this package, [Ruff](https://docs.astral.sh/ruff/), and create a\n`ruff.toml` or another Ruff supported configuration file in your project root.\nInside that file extend this config like so:\n\n```toml\nextend = \"nickineering-ruff-base.toml\"\n\n# Override these settings, or add your own here\n\n# For example:\n\n[format]\ndocstring-code-format = false\n```\n\nYou will also need to create a script to copy the file, since Ruff does not\nsupport extending from a package. This is a Poetry script which does that as an\nexample:\n\n```toml\n[tool.poetry.scripts]\nupdate-ruff-base = \"nickineering_ruff_config:update_ruff_base\"\n```\n\nYou could then run it with `poetry run update-ruff-base`. This would need to be\nre-run to install new versions of this package.\n\nFinally, add the output to your `.gitignore` so you can rely only on the\npackage.\n\n```gitignore\n# Automatically updated configuration file from nickineering-ruff-config\nnickineering-ruff-base.toml\n```\n\nIt is also recommended to create a `Makefile` or other command runner to\ndocument that the update-ruff-base command must be run when installing the\nproject and so that calls to Ruff run both the lint and format commands. An\nexample `Makefile` is below:\n\n```makefile\nsetup:\n    poetry install\n    poetry run update-ruff-base\n\nlint:\n    ruff format\n    ruff check --fix\n```\n\n## Publishing\n\nA Github Action is automatically run deploying this code to PyPi when a new\nrelease is published in Github.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickineering%2Fruff-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickineering%2Fruff-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickineering%2Fruff-config/lists"}