To get started, first make sure that you and your teammates have been put on the allow list for the Streamlit for Teams beta. Just email your contact at Streamlit to get set up. From there you'll be able to deploy Streamlit apps from your company's private GitHub repos and securely share them with your teammates and customers!
Make sure your app is in one of your private GitHub repos and that you have listed your dependencies. Streamlit looks at your requirements file’s filename to determine which Python dependency manager to use:
<aside> 🗒️ NOTE Only include packages in your requirements file that are not distributed with a standard Python installation. If any of the modules from base Python are included in the requirements file, you will get an error when you try to deploy. Additionally, use versions 0.69.2+ of Streamlit to ensure full sharing functionality.
</aside>
<aside> 🚧 WARNING You should only use one requirements file for your app.** If you include more than one (e.g. requirements.txt and Pipfile), only one will be installed, and we do not guarantee which file will be used.
</aside>
<aside> 🔑 If your app has never been deployed before with Streamlit, you will need admin permissions for the app's GitHub repository. You can read more about the GitHub permissions needed to deploy here.
</aside>
You should only use one requirements file for your app.** If you include more than one (e.g. requirements.txt and Pipfile), only one will be installed, and we do not guarantee which file will be used.
If package.txt exists in the repository we automatically detect it, parse it, and install the listed packages as described below. You can read more about apt-get in their docs.
Add apt-get dependencies to packages.txt, one package name per line. For example:
freeglut3-dev libgtk2.0-dev
The first thing you’ll see is a button to login with GitHub. Click on the button to login with the primary email associated with your GitHub account.
You can find your GitHub account email here:
Click “New app”, then fill in your repo, branch, and file path, and click “Deploy”. Your app will take a minute or two to deploy and then you’ll be ready to share!
If your app has a lot of dependencies it may take some time to deploy the first time. But after that, any change that does not touch your dependencies should show up immediately.