{"id":17149819,"url":"https://github.com/keeferrourke/pyapa","last_synced_at":"2025-06-17T17:40:43.492Z","repository":{"id":62578684,"uuid":"92905404","full_name":"keeferrourke/pyapa","owner":"keeferrourke","description":"A Python module for checking APA style. Not a papaya.","archived":false,"fork":false,"pushed_at":"2017-10-14T21:11:56.000Z","size":32,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-12T22:35:47.875Z","etag":null,"topics":["apa","apacheck","pyapa","python","python3","regex","style-checker","writing"],"latest_commit_sha":null,"homepage":"https://pypi.python.org/pypi/pyapa/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/keeferrourke.png","metadata":{"files":{"readme":"README.rst","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}},"created_at":"2017-05-31T04:49:08.000Z","updated_at":"2025-03-28T13:36:28.000Z","dependencies_parsed_at":"2022-11-03T21:00:23.759Z","dependency_job_id":null,"html_url":"https://github.com/keeferrourke/pyapa","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/keeferrourke/pyapa","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keeferrourke%2Fpyapa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keeferrourke%2Fpyapa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keeferrourke%2Fpyapa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keeferrourke%2Fpyapa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keeferrourke","download_url":"https://codeload.github.com/keeferrourke/pyapa/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keeferrourke%2Fpyapa/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260410123,"owners_count":23004802,"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":["apa","apacheck","pyapa","python","python3","regex","style-checker","writing"],"created_at":"2024-10-14T21:34:11.254Z","updated_at":"2025-06-17T17:40:38.473Z","avatar_url":"https://github.com/keeferrourke.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"pyapa\n=====\n\nA Python module for checking APA style in writing.\n\nThis module provides an abstraction class, mostly composed of regular\nexpressions. This project does not aim to cover the entire APA style\nguide, but it does attempt to cover several common errors with style.\n\nTo make errors easier to visually locate, 5 characters of context are\nsometimes given, depending on the detected error.\n\n\nInstallation\n------------\n\nClone this repository and run::\n\n    make install\n\nor install from Pypi::\n\n    pip3 install pyapa\n\n\nInformation\n-----------\n\nPypi: https://pypi.python.org/pypi/pyapa/\n\nGithub: https://github.com/keeferrourke/pyapa\n\nContact: https://krourke.org/contact\n\nLicense: ISC License\n\n\npyapa.ApaCheck object class\n---------------------------\n\nThis class documents regular expressions to match style errors.\n\nThe `pyapa.ApaCheck.match()` method generates an array of ApaMatch objects\nand stores them in the `ApaCheck.Matches` list for easy access.\n\n\npyapa.ApaMatch object class\n---------------------------\n\nThis class contains the following members:\n\n* `ApaMatch.feedback` a unicode string intended to hold a brief\n  explanation of an associated error\n* `ApaMatch.see` a URL string intended to hold an external reference to an APA\n  Style guide\n* `ApaMatch.end` the position of the character in a text which marks\n  the end of the target character span\n* `ApaMatch.start` the position of the character in a text which marks\n  the beginning of the target character span\n* `ApaMatch.target` the matching string that contains an error\n* `ApaMatch.suggestions` a list of suggested replacement strings; at\n  this time, the list is only ever one element long\n\nThere are also two helper functions to make printing these objects easy:\n\n* `ApaMatch.print()` prints the object to stdout\n* `ApaMatch.sprint()` builds a string containing information about the object\n\n\nExample usage\n-------------\n\nFrom the interpreter:\n\n\u003e\u003e\u003e from pyapa import pyapa\n\u003e\u003e\u003e a = pyapa.ApaCheck()\n\u003e\u003e\u003e text = u'Papaya are delicious fruit, it was concluded (Author, et al. 2017).'\n\u003e\u003e\u003e a.match(text)\n[\u003cpyapa.pyapa.ApaMatch object at 0x000000000000\u003e]\n\u003e\u003e\u003e len(a.Matches)\n1\n\u003e\u003e\u003e a.Matches[0].print()\nMatch from 46 to 65 for:\nTarget: Author, et al. 2017\nFeedback: Do not put a comma before 'et al.'\nSuggestion: Author et al. 2017\n\n\nCalling the module itself:\n\n::\n\n    python3 -m pyapa -i input.txt\n    python3 -m pyapa -h\n    Usage:\n    pyapa [-h] [--version] [-o OUTPUT_FILE] -i INPUT_FILE\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeeferrourke%2Fpyapa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeeferrourke%2Fpyapa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeeferrourke%2Fpyapa/lists"}