half the readmes

Author: abigalekim

README.md

@@ -1,3 +1,10 @@
 # Extension Analyzer
 
-This repository contains the code used to analyze the extension ecosystems of PostgreSQL, MySQL/MariaDB, SQLite, Redis, and DuckDB. The code for each of these systems can be found in their respective directories.
+This repository contains the code used to analyze the extension ecosystems of PostgreSQL, MySQL/MariaDB, SQLite, Redis, and DuckDB. The code for each of these systems and the instructions on how to run the analysis scripts can be found in their respective directories. Additionally, we have included our the CSVs
+used to run our plot scripts and our matplotlib scripts in these directories as well.
+
+Feel free to submit PRs and offer feedback, we would love to hear it!
+
+# Specifications
+- This code runs on a machine with Ubuntu 22.04. Compatibility with other OSes is not supported.
+- All Python scripts should work with Python version 3.12.

postgresql/README.md

@@ -1,28 +1,31 @@
 # pgext-analyzer
-Python scripts for generating compatibility tables and source code analysis. This is a work in progress, and for now is badly documented :,) Feel free to submit PRs and offer feedback, we would love to hear it.
+Python scripts for generating compatibility tables and source code analysis. 
 
 # Specifications
-- Runs on machine with Ubuntu 22.04. Compatibility with other OSes is not supported.
 - The tools use PostgreSQL 15.3. Compatibility with other versions of PostgreSQL is not supported.
+- You will also need to run this on a machine where you have root access.
 
 # Dependencies
-## Compatibility Analysis Dependencies
+Here are the Ubuntu packages you need to install to run the PostgreSQL analysis scripts:
 - readline
 - flex (for pg_tle)
-- mysql (for mysql_fdw), mysql runs with root
+- mysql (for mysql_fdw) (also make MySQL run with root)
 - libmysqlclient-dev (for mysql_fdw)
-- create ~/.my.cnf file with root user and password
 - libossp-uuid-dev (uuid-ossp)
 - libipc-run-perl
 - libperl-dev
 - libtinfo5
 - ninja-build
 - libsybdb5 freetds-dev freetds-common (tds_fdw)
 
+Lastly, for the `mysql_fdw` extension, you will need to create a `~/.my.cnf` file with root user and password.
+
 ## Source Code Analysis Dependencies
 - PMD CPD (https://github.com/pmd/pmd/releases/tag/pmd_releases/7.0.0-rc4)
 - sctokenizer (https://pypi.org/project/sctokenizer/)
 
+After installing PMD CPD you will need to put it in this directory (`PATH_TO_PROJECT/ext-analyzer/postgresql`).
+
 ## Static Analysis Dependencies
 - semgrep (pip install semgrep)
 

redis/README.md

@@ -0,0 +1,17 @@
+# redisext-analyzer
+Python scripts for extension testing analysis for Redis.
+
+# Dependencies
+The Python packages used in our implementation are:
+- csv
+- datetime
+- json
+- os
+- re
+- subprocess
+- urllib
+
+All of these should be automatically included with a Python installation, but if they are not, then they can be installed with `pip`.
+
+# Scripts
+There is one script that can be run: `source_code_analysis.py`. This script takes no arguments and outputs a CSV file containing source code statistics on Redis extensions. It can be run with default Python (`python3 source_code_analysis.py`).

sqlite/README.md

@@ -0,0 +1,25 @@
+# sqliteext-analyzer
+Python scripts for extension testing analysis for SQLite.
+
+# Dependencies
+The Python packages used in our implementation are:
+- csv
+- datetime
+- json
+- os
+- queue
+- random
+- re
+- sqlite3
+- subprocess
+- threading
+- urllib
+
+All of these should be automatically included with a Python installation, but if they are not, then they can be installed with `pip`.
+
+# Scripts
+There are two scripts that can be run. First, `source_code_analysis.py` takes no arguments and outputs a CSV file containing source code statistics on SQLite extensions. This script can be run with default Python
+(`python3 source_code_analysis.py`).
+
+The `compatibility.py` has one global variable (SINGLE, on line 11 of `compatibility.py`) that sets up the different modes of analysis. The single testing mode (`SINGLE = True`) allows each individual extension to be tested for functionality, while the compatibility testing mode (`SINGLE = False`) runs compatibility testing on all pairs of extensions. The output of this script is a CSV file with the compatibility results.
+This script can be run with default Python (`python3 compatibility.py`).