From 013e79cd7c7999e8eb2b737047523543e15ef75e Mon Sep 17 00:00:00 2001 From: fahdalkhulaifi <82029218+fahdalkhulaifi@users.noreply.github.com> Date: Mon, 2 Jun 2025 13:43:24 +0300 Subject: [PATCH] Update README with detailed utility descriptions and command-line mapping --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 821f05d7..4d755f24 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,25 @@ Certain utilities also have non-Python dependencies, which must be installed sep - `graph-sbol` requires [Graphviz](https://graphviz.org/) to be able to render diagrams. - `sbol-converter` requires [node.js](https://nodejs.org/en/) to be able to locally run Javascript. +## 🔗 Mapping: Command-Line Tools to Python Modules + +This table provides a quick reference to help developers understand where each command-line utility is implemented within the Python package. + +| **Command-line Tool** | **Python Module** | **Entry Point Function** | +| --------------------------- | ------------------------------------------------- | ------------------------ | +| `excel-to-sbol` | `sbol_utilities.excel_to_sbol` | `main` | +| `graph-sbol` | `sbol_utilities.graph_sbol` | `main` | +| `sbol-expand-derivations` | `sbol_utilities.expand_combinatorial_derivations` | `main` | +| `sbol-calculate-sequences` | `sbol_utilities.calculate_sequences` | `main` | +| `sbol-calculate-complexity` | `sbol_utilities.calculate_complexity_scores` | `main` | +| `sbol-converter` | `sbol_utilities.conversion` | `main` | +| `sbol2-to-sbol3` | `sbol_utilities.conversion` | `sbol2to3` | +| `sbol3-to-sbol2` | `sbol_utilities.conversion` | `sbol3to2` | +| `sbol-to-genbank` | `sbol_utilities.conversion` | `sbol2genbank` | +| `genbank-to-sbol` | `sbol_utilities.conversion` | `genbank2sbol` | +| `sbol-to-fasta` | `sbol_utilities.conversion` | `sbol2fasta` | +| `fasta-to-sbol` | `sbol_utilities.conversion` | `fasta2sbol` | +| `sbol-diff` | `sbol_utilities.sbol_diff` | `main` | ## Utilities