Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codersales/ai-research-project-referencing-program
AI Research Project Referencing Program
https://github.com/codersales/ai-research-project-referencing-program
2023 msc
Last synced: about 5 hours ago
JSON representation
AI Research Project Referencing Program
- Host: GitHub
- URL: https://github.com/codersales/ai-research-project-referencing-program
- Owner: CoderSales
- License: mit
- Created: 2023-12-09T19:30:19.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-29T14:57:24.000Z (4 months ago)
- Last Synced: 2024-06-29T16:01:38.304Z (4 months ago)
- Topics: 2023, msc
- Language: Python
- Homepage:
- Size: 198 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AI-Research-Project-Referencing-Program
## Description
AI Research Project Referencing Program Attempt
Take in BibTex file
downloaded for a journal article to be referenced
Outputs formatted reference.
(Some manual post editting necessary, like italics
and
repllacing Author first names
with initials)
## Recommended Requirements (setup tested for)
Windows
Visual Studio Code
wsl
wsl2
git bash
## To Run
clone or download repository
from root directory run
python -m venv .venv2
source .venv2/Scripts/activate
pip install -r requirements.txt
python main.py
### to edit
replace BibTex.bib
with a BibTex.bib
downloaded from the journal article to be referenced
run above command
## Table of Contents
Documentation
- [01st20docs](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/tree/main/documentation/01st20docs)
- has [20DEVELOPMENT.md](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/blob/main/documentation/01st20docs/20DEVELOPMENT.md)
- describes prior state of development of project
- [02nd20docs](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/tree/main/documentation/02nd20docs)
- has [21OldREADME.md](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/blob/main/documentation/02nd20docs/21OldREADME.md)
- includes:
- RegEx Quickguide
- imports openpyxl, NLTK
- References
- has [22DEVELOPMENT.md](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/blob/main/documentation/02nd20docs/22DEVELOPMENT.md)
- describes **current** state of development of project
- supercedes 01st20docs/20DEVELOPMENT.md
## Content
### Summary and Current Status
```text
TODO: (In Progress) Make an automatic referencing program.
- Input: Take BibTex.bib
- Output: Reference
- How it works:
- main.py calls a couple python files in the root directory like date.py
and imports folders files and functions from lines folder
- one file either author.py or journal.py
was used to develop functionality
of going through a line of the BibTex.bib
file
searching for a starting element
stripping this
and returning the relevant substring
then this was copied and edited
to add different functionality for the
various parts of the reference
main assembles these
and prints reference
- Next step : Trying to replace author first name with
initial and dot in author string
from author line
from
file
BibTex.bib
- nicetohave:
- for D.R.Y.
pass each lines identifier
e.g. journal
into a single file
or function call as an argument
and then
use same function
and send in the following:
```
```python
listOfIdentifiers=['author', 'journal', ]
for identifier in listOfIdentifiers:
listOfValues=[]
returnValue=functionCall(identifier)
listOfValues.append(returnValue)
listOfValues
```
```text
where functionCall
could be a single file
or
possibly
a
function directly in main.py
called which handles
for each line of
BibTex.bib
returns the corresponding
value
then need to
format listOfValues
into
output of reference
(similar to how currently done
in main.py
albeit currently
using print statement(s))
Add
GitHub suggested
automated workflow
.github/workflows/python-app.yaml
tests deploys
python application
```
## References
see [documentation](https://github.com/CoderSales/AI-Research-Project-Referencing-Program/tree/main/documentation)