Introduction

Streamlit demo for spatial data

Getting Started

To run the app, do

make run-app

and follow the instructions.

Contribute

Init

To start, please create a virtual environment. The Makefile assumes the name of the virtualenv is streamlit-urbana. Then, activate the environment.

Then, run:

make init

Then, install the rest of the dependencies as suggested in Dependencies.

Dependencies

To add/change a dependency, please edit the file requirements.in.

Then, run

pip-compile

The command abobe will update the requirements.txt accordingly.

If the dependency is related to development, please edit the file requirements-dev.in. Then, run

pip-compile requirements-dev.in

The command will update the file requirements-dev.txt.

Then, to update the environment with the new changes in requirements.txt (or requirements-dev.txt), run

pip-sync requirements.txt requirements-dev.txt

All the steps above can be done by using the Makefile:

make update-env

Run the app

To run the app, do:

make run-app

Commit conventions

This project adheres to the Conventional commits conventions. Consider using

cz commit

to get help writting the message of the commit. For more info, see commitizen.

Bump version

If you follow the commit conventions, commitizen will automatically bump the version according to semantic versioning.