The purpose of this repository is to provide an initial project template for Streamlit apps that simplifies and speeds up development.

To use the tamplate first clone this repository.

git clone https://github.com/pixpack/streamlit-base.git my-streamlit-app

Move into the templates directory.

cd my-streamlit-app

On Github you can also click the Use this template button to automatically create your own repository based on this template.

Create a virtual environment.

python -m venv .venv

Activate the virtual environment.

On Linux, macOS.

source .venv/bin/activate

On Windows (Powershell).

.venv/Scripts/Activate.ps1

Get the development dependencies.

python -m pip install --upgrade pip && \
pip install -r requirements-dev.txt

Start editing the app files in the app directory with your favourite editor.

For more information on how to develop Streamlit apps, check Streamlit documentation.

Start the app with the streamlit run command.

streamlit run app/main.py

Run the tests.

pytest

For more information on testing, visit pytest documentation.

The template is set up with Docker to deploy the app.

Configure the streamlit config.toml to your needs.

When changing the default ports in the configuration, remember to also change them in docker run command.

Build the Docker image.

docker build -t streamlit-app .

Run the container.

docker run -dp 8501:8501 streamlit-app

Contributions are very welcome.

To contribute:

1. Create an issue you would like to work on.
2. Fork the repository.
3. Create a pull request and attach the issue.

The initial streamlit config comes from the great Awesome Streamlit repository.