Ledgdex needs Python 3.8 or later, and dexweb. Pip installs dexweb with ledgdex. To publish to a git repository, for example on GitHub Pages, you also need git. To publish into a folder, you do not need git (Publishing a Ledgdex Online).
1. Install from the release. This is the recommended way:
pip install "ledgdex @ git+https://github.com/ledgdex/ledgdex@v1.0.18#subdirectory=py"2. Install with fast, constant-time signing. Use this way on each computer that signs. Without it, ledgdex shows a warning:
pip install "ledgdex[fast] @ git+https://github.com/ledgdex/ledgdex@v1.0.18#subdirectory=py"3. Install from a clone, to work on ledgdex itself:
git clone https://github.com/ledgdex/ledgdex
cd ledgdex
pip install -e "py[fast]"
cd py && python -m unittest discover -s tests4. Make sure that ledgdex works:
ledgdex --help
ledgdex verify https://ledgdex.github.io/docsYou do not install the JavaScript core. It is plain ES modules in js/. The site also serves these modules next to the viewer. See JavaScript Core and the API Reference.
Ledgdex keeps keys in ~/.ledgdex, or in $LEDGDEX_HOME when you set it. It keeps the verification cache in ~/.cache/ledgdex, or in $LEDGDEX_CACHE. See Configuration.