Merge branch 'main' of https://github.com/CoderSales/AI-Research-Proj…

…ect-Referencing-Program

.github/workflows/python-app.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

README.md

@@ -2,7 +2,21 @@
 
 ## Description
 
-AI-Research-Project-Referencing-Program-Attempt
+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)
 
@@ -79,13 +93,83 @@ TODO: (In Progress) Make an automatic referencing program.
 
 - 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  
+  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', <etc.> ]
+
+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)

documentation/01st20docs/10.md

@@ -23,6 +23,6 @@ vscode git char count on | https://www.google.com/search?q=vscode+git+char+count
 
 vscode turn on 50 char limit in git commit subject line | https://www.google.com/search?q=vscode+turn+on+50+char+limit+in+git+commit+subject+line&newwindow=1&sca_esv=589766361&rlz=1C1YTUH_enIE1084IE1084&sxsrf=AM9HkKk-gGYdC45euDUcfxGr9mmLTx-LUQ%3A1702302246610&ei=JhJ3ZbDuJMG2hbIPgMeNIA&ved=0ahUKEwiwmdaFwoeDAxVBW0EAHYBjAwQQ4dUDCBA&uact=5&oq=vscode+turn+on+50+char+limit+in+git+commit+subject+line&gs_lp=Egxnd3Mtd2l6LXNlcnAiN3ZzY29kZSB0dXJuIG9uIDUwIGNoYXIgbGltaXQgaW4gZ2l0IGNvbW1pdCBzdWJqZWN0IGxpbmUyBRAhGKABSKsPUKEBWMYNcAN4AZABAJgBgAGgAdQDqgEDNi4xuAEDyAEA-AEBwgIKEAAYRxjWBBiwA8ICBBAhGBXCAgcQIRigARgK4gMEGAAgQYgGAZAGCA&sclient=gws-wiz-serp
 
-cvscodee insiders git commit title character count missing | https://www.google.com/search?q=cvscodee+insiders+git+commit+title+character+count+missing&newwindow=1&sca_esv=589766361&rlz=1C1YTUH_enIE1084IE1084&sxsrf=AM9HkKmUtgr6aWf2-cjAAJS6QtkgL3evvQ%3A1702302163436&ei=0xF3ZfGBGrOzhbIPnoy6yA8&ved=0ahUKEwixt4HewYeDAxWzWUEAHR6GDvkQ4dUDCBA&uact=5&oq=cvscodee+insiders+git+commit+title+character+count+missing&gs_lp=Egxnd3Mtd2l6LXNlcnAiOmN2c2NvZGVlIGluc2lkZXJzIGdpdCBjb21taXQgdGl0bGUgY2hhcmFjdGVyIGNvdW50IG1pc3NpbmcyChAhGKABGMMEGApIxTJQpQxYpCtwAXgBkAEAmAFgoAGqCKoBAjE2uAEDyAEA-AEBwgIKEAAYRxjWBBiwA8ICBxAjGLACGCfCAggQABiJBRiiBMICCBAAGIAEGKIE4gMEGAAgQYgGAZAGCA&sclient=gws-wiz-serp
+cvscode insiders git commit title character count missing | https://www.google.com/search?q=cvscodee+insiders+git+commit+title+character+count+missing&newwindow=1&sca_esv=589766361&rlz=1C1YTUH_enIE1084IE1084&sxsrf=AM9HkKmUtgr6aWf2-cjAAJS6QtkgL3evvQ%3A1702302163436&ei=0xF3ZfGBGrOzhbIPnoy6yA8&ved=0ahUKEwixt4HewYeDAxWzWUEAHR6GDvkQ4dUDCBA&uact=5&oq=cvscodee+insiders+git+commit+title+character+count+missing&gs_lp=Egxnd3Mtd2l6LXNlcnAiOmN2c2NvZGVlIGluc2lkZXJzIGdpdCBjb21taXQgdGl0bGUgY2hhcmFjdGVyIGNvdW50IG1pc3NpbmcyChAhGKABGMMEGApIxTJQpQxYpCtwAXgBkAEAmAFgoAGqCKoBAjE2uAEDyAEA-AEBwgIKEAAYRxjWBBiwA8ICBxAjGLACGCfCAggQABiJBRiiBMICCBAAGIAEGKIE4gMEGAAgQYgGAZAGCA&sclient=gws-wiz-serp
 
-vscode insiders git commit title character count missing | https://www.google.com/search?q=vscode+insiders+git+commit+title+character+count+missing&newwindow=1&sca_esv=589766361&rlz=1C1YTUH_enIE1084IE1084&sxsrf=AM9HkKlpU1wBYYNcu5NSsnCmDwfDgps51g%3A1702311265036&ei=YTV3ZYHpAeK0hbIP6L250AE&ved=0ahUKEwjBnf_R44eDAxViWkEAHeheDhoQ4dUDCBA&uact=5&oq=vscode+insiders+git+commit+title+character+count+missing&gs_lp=Egxnd3Mtd2l6LXNlcnAiOHZzY29kZSBpbnNpZGVycyBnaXQgY29tbWl0IHRpdGxlIGNoYXJhY3RlciBjb3VudCBtaXNzaW5nMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADSL96ULJlWPhzcAN4AZABAJgBP6ABaaoBATK4AQPIAQD4AQHCAgcQIxiwAhgn4gMEGAAgQYgGAZAGCA&sclient=gws-wiz-serp
+vscode insiders git commit title character count missing | https://www.google.com/search?q=vscode+insiders+git+commit+title+character+count+missing&newwindow=1&sca_esv=589766361&rlz=1C1YTUH_enIE1084IE1084&sxsrf=AM9HkKlpU1wBYYNcu5NSsnCmDwfDgps51g%3A1702311265036&ei=YTV3ZYHpAeK0hbIP6L250AE&ved=0ahUKEwjBnf_R44eDAxViWkEAHeheDhoQ4dUDCBA&uact=5&oq=vscode+insiders+git+commit+title+character+count+missing&gs_lp=Egxnd3Mtd2l6LXNlcnAiOHZzY29kZSBpbnNpZGVycyBnaXQgY29tbWl0IHRpdGxlIGNoYXJhY3RlciBjb3VudCBtaXNzaW5nMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADMgoQABhHGNYEGLADSL96ULJlWPhzcAN4AZABAJgBP6ABaaoBATK4AQPIAQD4AQHCAgcQIxiwAhgn4gMEGAAgQYgGAZAGCA&sclient=gws-wiz-serp

documentation/Install/packages.md

@@ -1,7 +1,13 @@
 python.exe -m pip install --upgrade pip
+
 pip install openpyxl
+
 pip install numpy
+
 pip install pandas
+
 pip install nltk
+
 pip install --pre bibtexparser
+
 pip install regex