{"id":18524301,"url":"https://github.com/mdanalysis/mdalint","last_synced_at":"2026-03-14T16:11:24.534Z","repository":{"id":66359297,"uuid":"471328704","full_name":"MDAnalysis/mdalint","owner":"MDAnalysis","description":"Proof of concept for a MDAnalysis linter","archived":false,"fork":false,"pushed_at":"2022-03-18T14:02:45.000Z","size":15,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-10-29T17:34:54.118Z","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":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MDAnalysis.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":"AUTHORS","dei":null}},"created_at":"2022-03-18T10:42:22.000Z","updated_at":"2022-03-18T16:16:24.000Z","dependencies_parsed_at":"2023-02-22T03:45:13.039Z","dependency_job_id":null,"html_url":"https://github.com/MDAnalysis/mdalint","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"b08a39228b71f6567b46b80c3dba5548e5c7e5b0"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MDAnalysis%2Fmdalint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MDAnalysis%2Fmdalint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MDAnalysis%2Fmdalint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MDAnalysis%2Fmdalint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MDAnalysis","download_url":"https://codeload.github.com/MDAnalysis/mdalint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243179821,"owners_count":20249178,"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":"2024-11-06T17:40:30.530Z","updated_at":"2025-12-25T16:45:36.264Z","avatar_url":"https://github.com/MDAnalysis.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"MDA Lint\n========\n\n*MDA Lint is only a prototype!*\n\nMDA Lint is a linter for MDAnalysis and for programs using MDAnalysis. It\ndetects the use of MDAnalysis's API, makes sure they are applied appropriately,\nand offers suggestions to fix and improved their usage. The linter also awards\nbadges when it recognises good practices advocated by MDAnalysis.\n\n## Usage\n\n```bash\nmdalint /path/to/library/root\n```\n\nAt the end of a run, the program lists the badges that were awarded as well as\nerrors and warnings that were detected.\n\n## Badges\n\n### AnalysisBase\n\nThe tested program implements at least one analysis using the [`AnalysisBase`\nAPI](https://docs.mdanalysis.org/stable/documentation_pages/analysis/base.html).\nThis API allows to implement multi-frame analyses in a way that is consistent.\nIn most cases, it allows analyses to benefit from improvements to MDAnalysis\nwithout modification.\n\nThe badge is assigned when at least one class inherit from `AnalysisBase` and\nimplements a `_single_frame` method.\n\n#### Errors\n\nAn error is issued when:\n\n* a class inherit from `AnalysisBase` but does not\n  implements the `_single_frame` method. \n* the `run` method is overwritten and does not have the `start`, `stop`,\n  `step`, and `verbose` arguments.\n\n#### Warnings\n\nA warning is issued when:\n\n* the `run` method is overwritten.\n* the `_prepare`, `_single_frame`, or `_conclude` method take unexpected\n  arguments.\n* neither the `_single_frame` nor the `_conclude` method assign values in the\n  `results` attribute.\n\n### Reader\n\n### Parser\n\n### Writer\n\n### Topology attribute\n\n### Selection keyword\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdanalysis%2Fmdalint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdanalysis%2Fmdalint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdanalysis%2Fmdalint/lists"}