{"id":18869320,"url":"https://github.com/codersales/ai-research-project-referencing-program","last_synced_at":"2026-02-14T05:30:19.560Z","repository":{"id":212745756,"uuid":"729613346","full_name":"CoderSales/AI-Research-Project-Referencing-Program","owner":"CoderSales","description":"AI Research Project Referencing Program","archived":false,"fork":false,"pushed_at":"2025-01-19T14:02:03.000Z","size":194,"stargazers_count":0,"open_issues_count":13,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-19T14:49:00.719Z","etag":null,"topics":["2023","msc","referencing"],"latest_commit_sha":null,"homepage":"","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/CoderSales.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-12-09T19:30:19.000Z","updated_at":"2025-01-19T14:02:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"d3cdfe39-7c16-44f1-b589-54e91e9d4033","html_url":"https://github.com/CoderSales/AI-Research-Project-Referencing-Program","commit_stats":null,"previous_names":["codersales/ai-research-project-referencing-program"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoderSales%2FAI-Research-Project-Referencing-Program","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoderSales%2FAI-Research-Project-Referencing-Program/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoderSales%2FAI-Research-Project-Referencing-Program/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoderSales%2FAI-Research-Project-Referencing-Program/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CoderSales","download_url":"https://codeload.github.com/CoderSales/AI-Research-Project-Referencing-Program/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239816510,"owners_count":19701753,"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":["2023","msc","referencing"],"created_at":"2024-11-08T05:16:27.604Z","updated_at":"2026-02-14T05:30:19.498Z","avatar_url":"https://github.com/CoderSales.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AI-Research-Project-Referencing-Program\n\n## Reference\n\nRepo Cloned from [AI-Research-Project-Referencing-Program](https://github.com/CoderSales/AI-Research-Project-Referencing-Program) and modified.\n\n## Description\n\nAI Research Project Referencing Program Attempt\n\nTake in BibTex file\n\ndownloaded for a journal article to be referenced\n\nOutputs formatted reference.\n\n(Some manual post editting necessary, like italics \n\nand \n\nrepllacing Author first names\n\nwith initials)\n\n## Recommended Requirements (setup tested for)\n\nWindows\n\nVisual Studio Code\n\nwsl\n\nwsl2\n\ngit bash\n\n## To Run\n\nclone or download repository\n\nfrom root directory run\n\npython -m venv .venv2\n\nsource .venv2/Scripts/activate\n\npip install -r requirements.txt\n\npython main.py\n\n### to edit\n\nreplace BibTex.bib\n\nwith a BibTex.bib\n\ndownloaded from the journal article to be referenced\n\nrun above command\n\n## Table of Contents\n\nDocumentation\n\n- [01st20docs](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/tree/main/documentation/01st20docs)\n\n    - has [20DEVELOPMENT.md](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/blob/main/documentation/01st20docs/20DEVELOPMENT.md)\n\n        - describes prior state of development of project\n\n- [02nd20docs](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/tree/main/documentation/02nd20docs)\n\n    - has [21OldREADME.md](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/blob/main/documentation/02nd20docs/21OldREADME.md)\n\n        - includes:\n        \n        - RegEx Quickguide\n\n        - imports openpyxl, NLTK\n\n        - References\n\n    - has [22DEVELOPMENT.md](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/blob/main/documentation/02nd20docs/22DEVELOPMENT.md)\n\n        - describes **current** state of development of project\n\n        - supercedes 01st20docs/20DEVELOPMENT.md\n\n## Content\n\n### Summary and Current Status\n\n```text\nTODO: (In Progress) Make an automatic referencing program.\n\n- Input: Take BibTex.bib\n\n- Output: Reference\n\n- How it works:\n  - main.py calls a couple python files in the root directory like date.py\n    and imports folders files and functions from lines folder\n    - one file either author.py or journal.py\n      was used to develop functionality\n      of going through a line of the BibTex.bib\n      file\n      searching for a starting element\n      stripping this\n      and returning the relevant substring\n      then this was copied and edited\n      to add different functionality for the\n      various parts of the reference \n      main assembles these\n      and prints reference\n      \n\n- Next step : Trying to replace author first name with\n  initial and dot in author string\n  from author line\n  from\n  file\n  BibTex.bib\n\n- nicetohave:\n  - for D.R.Y.\n    pass each lines identifier\n    e.g. journal\n    into a single file\n    or function call as an argument\n    and then\n    use same function\n    and send in the following:\n    \n```\n\n```python\n\nlistOfIdentifiers=['author', 'journal', \u003cetc.\u003e ]\n\nfor identifier in listOfIdentifiers:\n    listOfValues=[]\n    returnValue=functionCall(identifier)\n    listOfValues.append(returnValue)\nlistOfValues\n```\n\n```text\nwhere functionCall\ncould be a single file\nor \npossibly\na\nfunction directly in main.py\ncalled which handles\nfor each line of\nBibTex.bib\nreturns the corresponding\nvalue\n\nthen need to\nformat listOfValues\ninto\noutput of reference\n(similar to how currently done\nin main.py\nalbeit currently\nusing print statement(s))\n\nAdd\nGitHub suggested\nautomated workflow\n.github/workflows/python-app.yaml\ntests deploys\npython application\n```\n\n## Troubleshooting\n\nIf it's not working:\n\ndelete space to the left of key value pairs in BibTex.bib file\n\ne.g.\n\n```BibTex\n@article{vaswani2023attentionneed,\n      title={Attention Is All You Need}, \n      author={Ashish Vaswani and Noam Shazeer and Niki Parmar and Jakob Uszkoreit and Llion Jones and Aidan N. Gomez and Lukasz Kaiser and Illia Polosukhin},\n      year={2023},\n      eprint={1706.03762},\n      archivePrefix={arXiv},\n      primaryClass={cs.CL},\n      url={https://arxiv.org/abs/1706.03762}, \n}\n```\n\nto this:\n\n```BibTex\n@article{vaswani2023attentionneed,\ntitle={Attention Is All You Need}, \nauthor={Ashish Vaswani and Noam Shazeer and Niki Parmar and Jakob Uszkoreit and Llion Jones and Aidan N. Gomez and Lukasz Kaiser and Illia Polosukhin},\nyear={2023},\neprint={1706.03762},\narchivePrefix={arXiv},\nprimaryClass={cs.CL},\nurl={https://arxiv.org/abs/1706.03762}, \n}\n```\n\nalso try ensuring BibTex.bib starts with\n\n```BibTex\n@article\n```\n\n## References\n\nsee [documentation](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/tree/main/documentation)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodersales%2Fai-research-project-referencing-program","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodersales%2Fai-research-project-referencing-program","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodersales%2Fai-research-project-referencing-program/lists"}