Bringing Order to a Python Streamlit App By an Organised Challenge Folder Construction

If you’re working with a Python mission that extends past just a few easy scripts and information recordsdata, you’ll know the complications that may be generated because the mission grows. This can lead to a cluttered folder consisting of enter recordsdata, intermediate recordsdata combined along with a number of Python recordsdata and / or pocket book recordsdata, and even mission documentation. This could make it laborious to seek out the info or the features you want when you’re searching for it.

There are quite a few articles on the market detailing construction Python tasks, that are very well-detailed. Nevertheless, on the subject of Streamlit (certainly one of my favorite Python instruments for growing web-based apps in a short time) I had hassle discovering info on how finest to construction a Streamlit app.

In consequence, I’ve put collectively this text to recommend one potential method of structuring your Streamlit app to stop it from changing into a tangled mess of recordsdata.

The Streamlit App folder construction and the Streamlit cookiecutter template proposed right here should not the one methods an app may very well be structured. There are quite a few different elements to think about, comparable to the kind of app you might be constructing and who that app is for. I encourage you to make use of the options on this article on your personal app and adapt it to fit your wants.

When I’m beginning with Streamlit — particularly after I don’t absolutely know what I wish to obtain or if I’m experimenting — I’ll typically begin with a easy listing and a single app.py file.

streamlit_app 
└── app.py

That is nice, as we are able to put all of our code into app.py after which name upon the command streamlit run app.py to begin the app within the browser.

This easy folder and single file can all of the sudden prolong to a number of recordsdata as information is gathered from the related sources or generated from the primary app.py file.

streamlit_app
├── app.py
├── data1.csv
├── random_data_file.csv
└── output.csv