Skip to content

Commit 1df4675

Browse files
authored
Merge pull request #324 from fahdalkhulaifi/develop
Improve README: Add detailed command-line tools mapping and usage instructions
2 parents df8ce2f + 013e79c commit 1df4675

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,25 @@ Certain utilities also have non-Python dependencies, which must be installed sep
2424
- `graph-sbol` requires [Graphviz](https://graphviz.org/) to be able to render diagrams.
2525
- `sbol-converter` requires [node.js](https://nodejs.org/en/) to be able to locally run Javascript.
2626

27+
## 🔗 Mapping: Command-Line Tools to Python Modules
28+
29+
This table provides a quick reference to help developers understand where each command-line utility is implemented within the Python package.
30+
31+
| **Command-line Tool** | **Python Module** | **Entry Point Function** |
32+
| --------------------------- | ------------------------------------------------- | ------------------------ |
33+
| `excel-to-sbol` | `sbol_utilities.excel_to_sbol` | `main` |
34+
| `graph-sbol` | `sbol_utilities.graph_sbol` | `main` |
35+
| `sbol-expand-derivations` | `sbol_utilities.expand_combinatorial_derivations` | `main` |
36+
| `sbol-calculate-sequences` | `sbol_utilities.calculate_sequences` | `main` |
37+
| `sbol-calculate-complexity` | `sbol_utilities.calculate_complexity_scores` | `main` |
38+
| `sbol-converter` | `sbol_utilities.conversion` | `main` |
39+
| `sbol2-to-sbol3` | `sbol_utilities.conversion` | `sbol2to3` |
40+
| `sbol3-to-sbol2` | `sbol_utilities.conversion` | `sbol3to2` |
41+
| `sbol-to-genbank` | `sbol_utilities.conversion` | `sbol2genbank` |
42+
| `genbank-to-sbol` | `sbol_utilities.conversion` | `genbank2sbol` |
43+
| `sbol-to-fasta` | `sbol_utilities.conversion` | `sbol2fasta` |
44+
| `fasta-to-sbol` | `sbol_utilities.conversion` | `fasta2sbol` |
45+
| `sbol-diff` | `sbol_utilities.sbol_diff` | `main` |
2746

2847
## Utilities
2948

0 commit comments

Comments
 (0)