Aleph.im Nodes List

Pre-fetch info from each resource node for the diverse ALEPH frontends.

Use a cache to not hammer the nodes too much. Implemented as an aleph program

The service exposes a Swagger UI at /docs and a Redoc UI at /redoc. Use it to explore the available endpoints.

Development

pip install hatch
cd src
hatch run uvicorn nodes_list.main:app --reload

Testing

Test the code quality using mypy:

hatch run linting:all

Reformat the code using ruff:

hatch fmt --formatter

Run the tests:

hatch run testing:test

Export the coverage in HTML:

hatch run testing:coverage html

Deployment

hatch run deployment:aleph program upload src nodes_list:app

Update an existing deployment:

hatch run deployment:aleph program update $ITEM_HASH src