A simple proof-of-concept API for rendering and querying beatles songs.
This project uses poetry for dependency management. To install on Linux or MacOS, use the following command:
curl -sSL https://install.python-poetry.org | python3 -To prepare the database, run the following commands:
poetry run src/manage.py migrate
DJANGO_SUPERUSER_USERNAME=evident \
DJANGO_SUPERUSER_PASSWORD=dev_interview \
DJANGO_SUPERUSER_EMAIL=admin@adm.in \
poetry run src/manage.py createsuperuser --no-input
poetry run src/manage.py import_songs data/task_data.csv
And to run the server locally, run the following command:
poetry run uvicorn --app-dir=src core.asgi:application
The browsable API will now be available in any web browser at http://localhost:8000/songs/. To view the songs individually, click on any url field's hyperlink to open the endpoint for that song, and go to /lyrics to view the relevant lyrics if they are stored on disk.
By default, songs will only show the fields name, rank, album and writers for unauthenticated users, but all fields will be visible once the user logs in at http://localhost:8000/auth/login/?next=/songs/ with the credentials mentioned (evident:dev_interview). You can also authenticate using Basic Authentication if not using the browsable API:
