Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added info on streamlit app to README #8

Merged
merged 5 commits into from
Oct 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,25 @@ app_file: app.py

# Postly

[![license](https://img.shields.io/github/license/DAVFoundation/captain-n3m0.svg?style=flat-square)](https://github.com/andreped/postly/blob/main/LICENSE.md)
<a target="_blank" href="https://huggingface.co/spaces/andreped/postly"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>

This repository contain the Postly client, which serves as a micro-message communication platform, similar to Twitter.

## Getting started
To access the live demo, click on the `Hugging Face` badge above. Below is a snapshot of the current state of the demo app.

Implemented client requires only Python >=3.7, no additional requirements.
<img width="1400" alt="Screenshot" src="https://github.com/andreped/assets/postly_image.png">

## Getting started

To use client, simply do something like this:
Install dependencies:
```
pip install -r requirements.txt
```
from postly.clients import PostlyClient

postly_instance = PostlyClient()
Run streamlit app:
```
streamlit run app.py
```

## Testing
Expand All @@ -34,6 +42,8 @@ For this project, we perform continuous integration to make sure that code is te
| Build Type | Status |
| - | - |
| **Unit tests** | [![CI](https://github.com/andreped/postly/workflows/Tests/badge.svg)](https://github.com/andreped/postly/actions) |
| **Check file size** | [![CI](https://github.com/andreped/postly/workflows/Check%20file%20size/badge.svg)](https://github.com/andreped/postly/actions) |
| **Unit tests** | [![CI](https://github.com/andreped/postly/workflows/Deploy/badge.svg)](https://github.com/andreped/postly/actions) |

To perform unit tests, you need to install `pytest`. For running formatting checks you also need `flake8`, `isort`, and `black`. We also depend on `pydantic` for type validation. To do so, lets configure a virtual environment:
```
Expand Down
Binary file added assets/streamlit-app-demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading