First beta version.

francisco-ortin · francisco-ortin · commit 4971500d6f74 · 2024-03-08T20:10:47.000+01:00
diff --git a/README.md b/README.md
@@ -1,2 +1,72 @@
-# PLangRec
-Programming language recognizer
+# *PLangRec*
+
+[![License](https://img.shields.io/github/license/ComputationalReflection/PLangRec)](LICENSE)
+[![Latest release](https://img.shields.io/github/v/release/computationalreflection/plangrec?include_prereleases)](https://github.com/ComputationalReflection/PLangRec/releases)
+<img alt="Code size" src="https://img.shields.io/github/languages/code-size/ComputationalReflection/PLangRec">
+<img alt="Repo size" src="https://img.shields.io/github/repo-size/ComputationalReflection/PLangRec">
+
+*Programming language recognizer*
+
+*PLangRec* is a character-level deep model to recognize the programming language of source code.
+
+*PLangRec* is provided as a Python desktop application, web API and web application.
+
+## Python desktop application
+
+Make sure you have Python installed. Then, install all the required packages:
+
+``` bash
+    pip install -r requirements.txt --upgrade
+``` 
+
+Make sure you have downloaded both the both `common` and the `desktop` folders, and they are
+both subdirectories of the same parent directory (the must be sibling directories).
+
+Finally, run *PLangRec* as a Python application (the model will be downloaded from the Internet, 
+so the first execution may take minutes):
+
+``` bash
+    cd desktop-app
+    python main.py
+``` 
+
+![Desktop application screenshot](img/desktop-app.png)
+
+## Web API
+
+Make sure you have Python installed. Then, install all the required packages:
+
+``` bash
+    pip install -r requirements.txt --upgrade
+``` 
+
+Make sure you have downloaded both the both `common` and the `web-api` folders, and they are
+both subdirectories of the same parent directory (the must be sibling directories).
+
+Finally, run *PLangRec* as a Web API (the model will be downloaded from the Internet, 
+so the first execution may take minutes):
+
+``` bash
+    cd web-api
+    python main.py
+``` 
+
+## Web application
+
+For the web application, you need to deploy the Web API
+because the application consumes the API.
+
+Steps:
+
+1. Deploy the Web API in one server. 
+2. Download the `web-app` folder to your web server. 
+3. Modify the value of the `WEB_SERVER` variable in the `index.html` file, 
+setting its value to the server where you have the web API (step 1).    
+
+The Web application will be ready, calling the Web API.
+
+![Web application screenshot](img/web-app.png)
+
+## License
+
+[MIT license](LICENSE).
diff --git a/desktop-app/main.py b/desktop-app/main.py
@@ -1,7 +1,6 @@
 from tkinter import Tk, END, E, W, ttk, StringVar, BooleanVar, NORMAL, DISABLED, Text, Event
 from tkinter.ttk import Button, Combobox, LabelFrame, Treeview, Style
 from example_code import PROGRAM_EXAMPLES
-from languages import LANGUAGES
 
 
 def sort_number(table: Treeview, column_name: str, ascending: bool) -> None:
@@ -53,6 +52,7 @@ def main() -> None:
     query_frame.columnconfigure(1, weight=1)
 
     # Combobox inside LabelFrame to pick one predefined text of source code
+    from languages import LANGUAGES
     cmb = Combobox(query_frame, values=LANGUAGES, state="readonly")
     cmb.grid(row=1, column=0, padx=5, pady=(15, 0))
     cmb.current(0)  # Default pick
diff --git a/img/desktop-app.png b/img/desktop-app.png
diff --git a/img/web-app.png b/img/web-app.png
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,175 @@
+absl-py==2.0.0
+anyio==4.2.0
+argon2-cffi==23.1.0
+argon2-cffi-bindings==21.2.0
+arrow==1.3.0
+asttokens==2.4.1
+astunparse==1.6.3
+async-lru==2.0.4
+attrs==23.2.0
+Babel==2.14.0
+bcrypt==4.0.1
+beautifulsoup4==4.12.3
+bleach==6.1.0
+blinker==1.6.3
+cachetools==5.3.2
+certifi==2023.7.22
+cffi==1.16.0
+chardet==5.2.0
+charset-normalizer==3.3.2
+click==8.1.7
+colorama==0.4.6
+coloredlogs==15.0.1
+colour==0.1.5
+comm==0.2.1
+contourpy==1.1.1
+cryptography==41.0.4
+cycler==0.12.1
+debugpy==1.8.0
+decorator==5.1.1
+defusedxml==0.7.1
+dm-tree==0.1.8
+dtreeviz==2.2.2
+executing==2.0.1
+fastjsonschema==2.19.1
+Flask==3.0.0
+Flask-Cors==4.0.0
+flatbuffers==23.5.26
+fonttools==4.43.1
+fqdn==1.5.1
+gast==0.5.4
+google-auth==2.25.2
+google-auth-oauthlib==1.1.0
+google-pasta==0.2.0
+graphviz==0.20.1
+greenlet==3.0.0
+grpcio==1.60.0
+h5py==3.10.0
+humanfriendly==10.0
+idna==3.4
+iniconfig==2.0.0
+ipykernel==6.29.0
+ipython==8.21.0
+ipywidgets==8.1.1
+isoduration==20.11.0
+itsdangerous==2.1.2
+jedi==0.19.1
+Jinja2==3.1.2
+joblib==1.3.2
+json5==0.9.14
+jsonpointer==2.4
+jsonschema==4.21.1
+jsonschema-specifications==2023.12.1
+jupyter==1.0.0
+jupyter-console==6.6.3
+jupyter-events==0.9.0
+jupyter-lsp==2.2.2
+jupyter_client==8.6.0
+jupyter_core==5.7.1
+jupyter_server==2.12.5
+jupyter_server_terminals==0.5.2
+jupyterlab==4.0.12
+jupyterlab-widgets==3.0.9
+jupyterlab_pygments==0.3.0
+jupyterlab_server==2.25.2
+keras==2.15.0
+kiwisolver==1.4.5
+libclang==16.0.6
+logging==0.4.9.6
+Markdown==3.5.1
+markdown-it-py==3.0.0
+MarkupSafe==2.1.3
+matplotlib==3.8.0
+matplotlib-inline==0.1.6
+mdurl==0.1.2
+mistune==3.0.2
+ml-dtypes==0.2.0
+mpld3==0.5.10
+namex==0.0.7
+nbclient==0.9.0
+nbconvert==7.14.2
+nbformat==5.9.2
+nest-asyncio==1.6.0
+notebook==7.0.7
+notebook_shim==0.2.3
+numpy==1.26.1
+oauthlib==3.2.2
+opt-einsum==3.3.0
+overrides==7.7.0
+packaging==23.2
+pandas==2.1.1
+pandocfilters==1.5.1
+paramiko==3.3.1
+parso==0.8.3
+patsy==0.5.3
+Pillow==10.1.0
+platformdirs==4.2.0
+pluggy==1.3.0
+prometheus-client==0.19.0
+prompt-toolkit==3.0.43
+protobuf==4.23.4
+psutil==5.9.8
+psycopg2==2.9.9
+psycopg2-binary==2.9.9
+pure-eval==0.2.2
+pyasn1==0.5.1
+pyasn1-modules==0.3.0
+pycparser==2.21
+Pygments==2.17.2
+PyNaCl==1.5.0
+pyparsing==3.1.1
+pyreadline3==3.4.1
+pytest==7.4.3
+python-dateutil==2.8.2
+python-json-logger==2.0.7
+pytz==2023.3.post1
+pywin32==306
+pywinpty==2.0.12
+PyYAML==6.0.1
+pyzmq==25.1.2
+qtconsole==5.5.1
+QtPy==2.4.1
+referencing==0.33.0
+requests==2.31.0
+requests-oauthlib==1.3.1
+rfc3339-validator==0.1.4
+rfc3986-validator==0.1.1
+rich==13.7.0
+rpds-py==0.17.1
+rsa==4.9
+scikit-learn==1.3.1
+scipy==1.11.3
+seaborn==0.13.2
+Send2Trash==1.8.2
+six==1.16.0
+sklearn==0.0.post10
+sniffio==1.3.0
+soupsieve==2.5
+SQLAlchemy==2.0.22
+sshtunnel==0.4.0
+stack-data==0.6.3
+statsmodels==0.14.0
+tensorboard==2.15.1
+tensorboard-data-server==0.7.2
+tensorflow==2.15.0
+tensorflow-estimator==2.15.0
+tensorflow-intel==2.15.0
+tensorflow-io-gcs-filesystem==0.31.0
+termcolor==2.4.0
+terminado==0.18.0
+threadpoolctl==3.2.0
+tinycss2==1.2.1
+tornado==6.4
+traitlets==5.14.1
+types-python-dateutil==2.8.19.20240106
+typing_extensions==4.8.0
+tzdata==2023.3
+uri-template==1.3.0
+urllib3==2.0.7
+wcwidth==0.2.13
+webcolors==1.13
+webencodings==0.5.1
+websocket-client==1.7.0
+Werkzeug==3.0.1
+widgetsnbextension==4.0.9
+wrapt==1.14.1
diff --git a/wep-app/index.html b/wep-app/index.html
@@ -56,7 +56,7 @@
 		<h1 class="display-4">
 			PLangRec
 		</h1>
-		<p class="text-secondary" style="font-size:1.5em;"><i>Character-level model to recognize the programming language of source code</i></p>
+		<p class="text-secondary" style="font-size:1.5em;"><i>Character-level deep model to recognize the programming language of source code</i></p>
 		
 
 		<div id="analysisRowDiv" class="row pt-4"> 
@@ -153,6 +153,7 @@ <h2 class="p-3 col-11 text-center">Programming Language</h2>
   </body>
 
 <script>
+	const WEB_SERVER = 'http://127.0.0.1:5000'
 	function selectExampleLanguage(language) {
 		const example_code = {
 			"Assembly": "ADD CX, [BX+SI*2+10]",
@@ -185,7 +186,7 @@ <h2 class="p-3 col-11 text-center">Programming Language</h2>
 	}
 	function buttonClicked() {
 		// do the prediction by calling the web API
-		fetch('http://127.0.0.1:5000/BRNN/predict?source_code=' + document.getElementById("source-code").value)
+		fetch(WEB_SERVER + '/BRNN/predict?source_code=' + document.getElementById("source-code").value)
 			.then(response => response.json())
 			.then(data => {
 				// Handle the response data and populate the HTML table
