{"id":18330686,"url":"https://github.com/suffolklitlab/ratemypdf","last_synced_at":"2026-03-19T03:57:09.234Z","repository":{"id":156644598,"uuid":"626426456","full_name":"SuffolkLITLab/RateMyPDF","owner":"SuffolkLITLab","description":"RateMyPDF is a website that helps paper form authors (particularly for court forms) improve the usability of their forms for self-represented litigants. It uses the FormFyxer library to deliver its insights.","archived":false,"fork":false,"pushed_at":"2023-08-24T15:07:44.000Z","size":116,"stargazers_count":1,"open_issues_count":18,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-18T10:21:44.607Z","etag":null,"topics":["complexity-analysis","forms","pdf","plainlanguage","readability"],"latest_commit_sha":null,"homepage":"https://ratemypdf.com","language":"HTML","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/SuffolkLITLab.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":"2023-04-11T12:55:29.000Z","updated_at":"2024-05-29T23:21:02.765Z","dependencies_parsed_at":"2024-05-29T23:21:00.450Z","dependency_job_id":"0688e343-65f3-4024-9b83-7b283901db86","html_url":"https://github.com/SuffolkLITLab/RateMyPDF","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/SuffolkLITLab%2FRateMyPDF","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SuffolkLITLab%2FRateMyPDF/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SuffolkLITLab%2FRateMyPDF/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SuffolkLITLab%2FRateMyPDF/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SuffolkLITLab","download_url":"https://codeload.github.com/SuffolkLITLab/RateMyPDF/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248083089,"owners_count":21045036,"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":["complexity-analysis","forms","pdf","plainlanguage","readability"],"created_at":"2024-11-05T19:24:49.963Z","updated_at":"2026-02-28T04:04:43.105Z","avatar_url":"https://github.com/SuffolkLITLab.png","language":"HTML","readme":"# RateMyPDF\nRateMyPDF is a website that helps paper form authors (particularly for court forms) improve the usability of their forms for self-represented litigants. It uses the FormFyxer library to deliver its insights.\n\nThe [first version](https://github.com/SuffolkLITLab/docassemble-PDFStats) of this website ran on Flask. This repository replaces it with a version on FastAPI.\n\nIt has been described in a paper published in the proceedings\nof ICAIL '23. You can view it [here](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/complexity/complexity/#download-and-cite-our-paper).\n\n## Running locally\n\nInstall requirements:\n\n- formfyxer\n- redis. Follow install install instructions here: https://redis.io/docs/getting-started/installation/install-redis-on-linux/\n- rq: pip install rq\n\n\nStart redis queue to handle incoming jobs\n\n```bash\ncd ~/RateMyPDF/app\nrq worker\n```\n\nStart the fastapi app, setting the redis URL to `localhost`\n\n```bash\ncd ~/RateMyPDF/app\nREDIS_URL=redis://localhost:6379 python main.py\n```\n\nThe site should now be available at http://localhost:8000\n\n## Starting in Docker\n\nCopy the `.env.example` file to `.env`\n\n```yaml\nDOMAIN=ratemypdf.com\nOPEN_AI__org=org-\nOPEN_AI__key=sk-\nSPOT_TOKEN=\nTOOLS_TOKEN=\nIN_DOCKER=TRUE\nREDIS_URL=redis://ratemypdf_redis:6379\n```\n\nFill in the missing values with the appropriate domain name, key, etc.\n\nAccess to the spot and tools tokens is available only by contacting suffolklitlab@gmail.com\n\n## Preferred citation format\n\nPlease cite this repository as follows:\n\nQuinten Steenhuis, Bryce Willey, and David Colarusso. 2023. Beyond Readability with RateMyPDF: A Combined Rule-based and Machine Learning Approach to Improving Court Forms. In _Proceedings of International Conference on Artificial Intelligence and Law (ICAIL 2023). ACM, New York, NY, USA, 10 pages_. https://doi.org/10.1145/3594536.3595146\n\nBibtex format:\n```bibtex\n@article{Steenhuis_Willey_Colarusso_2023, title={Beyond Readability with RateMyPDF: A Combined Rule-based and Machine Learning Approach to Improving Court Forms}, DOI={https://doi.org/10.1145/3594536.3595146}, journal={Proceedings of International Conference on Artificial Intelligence and Law (ICAIL 2023)}, author={Steenhuis, Quinten and Willey, Bryce and Colarusso, David}, year={2023}, pages={287–296}}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuffolklitlab%2Fratemypdf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuffolklitlab%2Fratemypdf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuffolklitlab%2Fratemypdf/lists"}