Skip to content

Commit

Permalink
updated docs and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Marc Skov Madsen authored and Marc Skov Madsen committed Oct 17, 2019
1 parent 9109e0a commit a6be9f4
Show file tree
Hide file tree
Showing 36 changed files with 1,186 additions and 178 deletions.
43 changes: 27 additions & 16 deletions README.md
@@ -1,6 +1,6 @@
# Awesome Streamlit [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/MarcSkovMadsen/awesome-streamlit)

[<img src="https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/streamlit-logo.png?raw=true" align="right" height="25">](https://streamlit.io)
[<img src="https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/streamlit-logo.png?raw=true" align="right" height="75" width="75">](https://streamlit.io)

> The fastest way to build **Awesome Tools and Apps**! Powered by **Python**!
Expand Down Expand Up @@ -30,9 +30,9 @@ If you know how to solve this please let me know. Thanks

The only way to truly understand how magical Streamlit is to play around with it, but if you need to be convinced first, then here is the **4 minute introduction** to Streamlit!

Afterwards you can go to the [Streamlit docs](https://streamlit.io/docs/) to get started.
Afterwards you can go to the [Streamlit docs](https://streamlit.io/docs/) to get started. You might also visit [Awesome Streamlit docs](https://awesome-streamlit.readthedocs.io/en/latest/).

[![Introduction to Streamlit](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/youtube-introduction-to-streamlit.png)](https://www.youtube.com/watch?v=B2iAodr0fOo&feature=youtu.be "Introduction to streamlit")
[![Introduction to Streamlit](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/youtube-introduction-to-streamlit.png?raw=true)](https://www.youtube.com/watch?v=B2iAodr0fOo&feature=youtu.be "Introduction to streamlit")

## Awesome Resources

Expand All @@ -44,16 +44,31 @@ A curated list of awesome streamlit resources. Inspired by [awesome-python](http
- [Jupyter Voila](https://blog.jupyter.org/and-voil%C3%A0-f6a2c08a4a93)
- [Plotly Dash](https://plot.ly/dash/)

### Apps
### App

- [Kaggle Mushrooms Dashboard](https://github.com/pierpaolo28/Data-Visualization/tree/master/Streamlit)
- [Sentiment Analyzer Tool](https://www.linkedin.com/posts/patidarparas13_code-ml-machinelearning-ugcPost-6585745929062703104-ttkv)
- [SpacyIO Application](https://gist.github.com/ines/b320cb8441b590eedf19137599ce6685)
- [Streamlit-components-demo App](https://fullstackstation.com/streamlit-components-demo)

### Awesome-Streamlit.org

- [App](https://awesome-streamlit.org>)
- [Awesome Streamlit Resources List](ttps://github.com/marcskovmadsen/awesome-streamlit)
- [Docker Image](https://cloud.docker.com/u/marcskovmadsen/repository/docker/marcskovmadsen/awesome-streamlit)
- [Docs](https://awesome-streamlit.readthedocs.io/en/latest/)
- [LinkedIn post that started awesome-streamlit.org](https://www.linkedin.com/feed/update/urn:li:activity:6586497522896818176)
- [Python Package](https://pypi.org/project/awesome-streamlit/)
- [Repo](https://github.com/marcskovmadsen/awesome-streamlit)

### Code

- [Deploying Streamlit app to EC2 instance](https://medium.com/@pokepim/deploying-streamlit-app-to-ec2-instance-7a7edeffbb54)
- [Sentiment Algorithm](https://raw.githubusercontent.com/MarcSkovMadsen/awesome-streamlit/master/src/pages/gallery/contributions/marc_skov_madsen/sentiment_analyzer/sentiment_analyzer.py)
- [SpacyIO](https://gist.githubusercontent.com/ines/b320cb8441b590eedf19137599ce6685/raw/6e0ead5a442fd9c5e3f621a76fba94241cc847ce/streamlit_spacy.py)
- [Spreadsheet](https://raw.githubusercontent.com/MarcSkovMadsen/awesome-streamlit/master/src/pages/gallery/contributions/marc_skov_madsen/spreadsheet.py)
- [Streamlit-components-demo Code](https://github.com/virusvn/streamlit-components-demo)
- [Uber Data Explorer App](https://dataexplorerlit.herokuapp.com/)
- [Uber NYC Pickups](https://raw.githubusercontent.com/streamlit/demo-uber-nyc-pickups/master/app.py)

### Social

Expand All @@ -62,6 +77,7 @@ A curated list of awesome streamlit resources. Inspired by [awesome-python](http

### Streamlit.io

- [Streamlit](https://techcrunch.com/2019/10/01/streamlit-launches-open-source-machine-learning-application-development-framework/)
- [Streamlit Community](https://discuss.streamlit.io/top/quarterly)
- [Streamlit Docs](https://streamlit.io/docs/)
- [Streamlit.io](https://streamlit.io/)
Expand All @@ -72,10 +88,6 @@ A curated list of awesome streamlit resources. Inspired by [awesome-python](http

- [Hacker News technical discussion of how Streamlit work](https://news.ycombinator.com/item?id=21158487)

### The beginning

- [LinkedIn post that started awesome-streamlit.org](https://www.linkedin.com/feed/update/urn:li:activity:6586497522896818176)

## Governance

This repo is maintained by me :-)
Expand Down Expand Up @@ -189,7 +201,7 @@ Marc

[Attribution-ShareAlike 4.0 International](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/license.md)

## Getting Started with the Awesome Streamlit Application
## Getting Started with the Awesome Streamlit Repository

### Prerequisites

Expand Down Expand Up @@ -313,8 +325,7 @@ or in Docker
docker run -it -p 80:80 --entrypoint "streamlit" marcskovmadsen/awesome-streamlit:latest run test_runner_app.py
```

![Awesome Streamlit Test Runner](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/awesome-streamlit-test-runner.png)

![Awesome Streamlit Test Runner](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/awesome-streamlit-test-runner.png?raw=true)

### Workflow

Expand Down Expand Up @@ -352,19 +363,19 @@ The application is
- build as a Docker image and tested via Azure Pipelines builds
- You find the Dockerfiles [here](https://github.com/MarcSkovMadsen/awesome-streamlit/tree/master/devops/docker) and the Azure pipelines yml files [here](https://github.com/MarcSkovMadsen/awesome-streamlit/tree/master/devops/azure-pipelines)

![Azure Pipelines](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/azure-pipeline.png)
![Azure Pipelines](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/azure-pipeline.png?raw=true)

- pushed to the Dockerhub repository [marcskovmadsen/awesome-streamlit](https://cloud.docker.com/u/marcskovmadsen/repository/docker/marcskovmadsen/awesome-streamlit).

![Dockerhub](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/dockerhub.png)
![Dockerhub](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/dockerhub.png?raw=true)

- released via Azure Pipelines

![Azure Pipelines](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/azure-pipeline-release.png)
![Azure Pipelines](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/azure-pipeline-release.png?raw=true)

- to a web app for containers service on Azure on the cheapest non-free pricing tier

![Azure Pipelines](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/azure-pricing-tier.png)
![Azure Pipelines](https://github.com/MarcSkovMadsen/awesome-streamlit/blob/master/assets/azure-pricing-tier.png?raw=true)

### The Awesome-Streamlit Package

Expand Down
2 changes: 1 addition & 1 deletion contributing.md
Expand Up @@ -2,7 +2,7 @@

Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.

# The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away because I'm so tired of nobody reading this document. Please carefully read everything in `Adding to this list`.
** The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away because I'm so tired of nobody reading this document. Please carefully read everything in `Adding to this list`.**

## Table of Contents

Expand Down
1 change: 1 addition & 0 deletions devops/docker/Dockerfile.prod
Expand Up @@ -15,6 +15,7 @@ RUN mkdir ~/.streamlit
RUN cp .streamlit/config.prod.toml ~/.streamlit/config.toml
RUN cp .streamlit/credentials.prod.toml ~/.streamlit/credentials.toml
RUN cp config.prod.py config.py
RUN invoke sphinx.copy-from-project-root

WORKDIR /app

Expand Down

0 comments on commit a6be9f4

Please sign in to comment.