synapseconvert 0.1.7

Tools for converting Synapse RTP JSON to spreadsheet and back.

synapseconvert

A simple two-way converter for Synapse-style libraries (collections → categories → items) using Excel and JSON. This is intended for developers working with Synapse, a research transport protocol designed for structured academic resources.

📦 Installation

Install via pip:

pip install synapseconvert

You’ll then have access to the command-line tools:
	•	synapse-upconvert
	•	synapse-downconvert

🛠 Usage

Convert from Excel to JSON (Upconvert)

synapse-upconvert path/to/input.xlsx path/to/output.json

This reads a spreadsheet and produces a properly nested Synapse metadata file.

Convert from JSON to Excel (Downconvert)

synapse-downconvert path/to/input.json path/to/output.xlsx

This flattens a Synapse-style JSON file into a spreadsheet for editing or review.

📄 Spreadsheet Format

The spreadsheet must contain at least the following columns:
	•	collection – the name of the collection (uniform across all rows)
	•	category – name of the group the item belongs to
	•	title, description, etc. – all other metadata fields are treated as item fields
	•	tags – a valid JSON list (e.g., ["Genesis", "Luke"])

📁 Sample template files:
	•	sample.xlsx
	•	sample.json

These are included in the installed package and available for download or reference from the templates folder on GitHub.
https://github.com/sbaylis22/synapseconvert

🧠 Why This Exists

Synapse is designed to bring remote research libraries directly into Obsidian. Since BiblicalStory cannot create Synapse files for every research repository in existence, we are providing these tools so developers can build Synapse libraries for any collection. These libraries can then be added in the Synapse settings within Obsidian.

🔧 Developer Tools

For advanced usage, you can clone this repo and run the commands locally from source:

git clone https://github.com/BiblicalStory/synapseconvert.git
cd synapseconvert
pip install -e .


⸻

© 2025 BiblicalStory Incorporated. MIT License.

---

Let me know if you'd like to add a `synapse-template-path` CLI command or a Python example to programmatically access the templates inside the installed package.