Add essence-feature-usage-stats tool

.gitignore

@@ -1,3 +1,10 @@
 target
 
 solvers/**/vendor/build
+tools/essence-feature-usage-stats/.venv
+tools/essence-feature-usage-stats/stats/__pycache__
+tools/essence-feature-usage-stats/utils/__pycache__
+tools/essence-feature-usage-stats/.idea
+tools/essence-feature-usage-stats/test/__pycache__
+tools/essence-feature-usage-stats/web/__pycache__
+

tools/essence-feature-usage-stats/.env

@@ -0,0 +1,9 @@
+ESSENCE_DIR=/home/mayday/Coding/VIP/EssenceCatalog
+CONJURE_DIR=/home/mayday/Coding/VIP/conjure-v2.5.0-linux-with-solvers
+ESSENCE_EXAMPLES_REPO=https://github.com/conjure-cp/EssenceCatalog.git
+KEYWORD_BLOCKLIST="mInfo,finds,givens,enumGivens,enumLettings,lettings,
+ unnameds,strategyQ,Auto,Interactive,strategyA,trailCompact,
+ nameGenState,nbExtraGivens,representations,representationsTree,
+ originalDomains,trailGeneralised,trailVerbose,trailRewrites,
+ mLanguage,language,version,mStatements,Name,Declaration,FindOrGiven,
+ SuchThat,Op"

tools/essence-feature-usage-stats/README.md

@@ -0,0 +1,45 @@
+# essence-feature-usage-stats
+
+## About
+
+This is an internal tool for the [conjure-oxide](https://github.com/conjure-cp/conjure-oxide) project.
+
+It does the following:
+- Given a directory containing Essence files, go through it and count how often every Essence language feature is used
+- Display this data as a simple web page with a table
+
+The purpose of this is to make it easier to find Essence examples to test specific Essence language features, which should be useful over the course of rewriting the conjure tool stack in Rust
+
+
+## Usage
+
+> This is heavily WIP and I am planning to make this more usable in the future.
+> Eventually, this will be a Flask web server to host the web page, a better frontend (to make it searchable, sortable, etc), and the page will auto-update on changes to the relevant Essence example repos
+
+For now, though:
+
+- Put paths to conjure directory and Essence file directory in .env
+- Run the main.py file
+- See the generated HTML file
+
+
+## ToDo
+
+- [x] Get basic stats in JSON format
+- [x] Get basic stats as HTML table
+- [ ] Table sorting
+- [x] Code refactoring
+- [ ] Documentation
+- [ ] Show/Hide table rows/columns
+- [ ] Web server for hosting the HTML page
+- 🏗️ GitHub Actions integration
+- [x] Extra stats, e.g. file line count
+- [ ] Sorting using these stats
+
+
+------------------------------------------
+
+- Georgii Skorokhod and Hannah Zheng, 2023
+- University of St Andrews
+- Developed as part of a Vertically Integrated Project by Ozgur Akgun et al
+- (See [main repos](https://github.com/conjure-cp))

tools/essence-feature-usage-stats/main.py

@@ -0,0 +1,27 @@
+import os
+from pathlib import Path
+
+from dotenv import load_dotenv
+
+from stats.essence_stats import EssenceStats
+from web.server import create_server
+
+ENV_PATH = Path("./.env").resolve()
+load_dotenv(dotenv_path=ENV_PATH)
+
+KEYWORD_BLOCKLIST = [x.strip() for x in os.getenv("KEYWORD_BLOCKLIST").split(",")]
+ESSENCE_DIR = os.getenv("ESSENCE_DIR")
+CONJURE_DIR = os.getenv("CONJURE_DIR")
+ESSENCE_EXAMPLES_REPO = os.getenv("ESSENCE_EXAMPLES_REPO")
+CONJURE_BIN = Path(CONJURE_DIR) / "conjure"
+
+if __name__ == "__main__":
+ stats = EssenceStats(
+ ESSENCE_DIR,
+ CONJURE_BIN,
+ ESSENCE_EXAMPLES_REPO,
+ blocklist=KEYWORD_BLOCKLIST,
+ )
+
+ app = create_server(stats)
+ app.run()