andreped commited on
Commit
cc4b83e
·
unverified ·
2 Parent(s): 2ba0389 6011898

Merge pull request #8 from andreped:docs

Browse files
Files changed (2) hide show
  1. README.md +15 -5
  2. assets/streamlit-app-demo.png +0 -0
README.md CHANGED
@@ -14,17 +14,25 @@ app_file: app.py
14
 
15
  # Postly
16
 
 
 
 
17
  This repository contain the Postly client, which serves as a micro-message communication platform, similar to Twitter.
18
 
19
- ## Getting started
20
 
21
- Implemented client requires only Python >=3.7, no additional requirements.
 
 
22
 
23
- To use client, simply do something like this:
 
 
24
  ```
25
- from postly.clients import PostlyClient
26
 
27
- postly_instance = PostlyClient()
 
 
28
  ```
29
 
30
  ## Testing
@@ -34,6 +42,8 @@ For this project, we perform continuous integration to make sure that code is te
34
  | Build Type | Status |
35
  | - | - |
36
  | **Unit tests** | [![CI](https://github.com/andreped/postly/workflows/Tests/badge.svg)](https://github.com/andreped/postly/actions) |
 
 
37
 
38
  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:
39
  ```
 
14
 
15
  # Postly
16
 
17
+ [![license](https://img.shields.io/github/license/DAVFoundation/captain-n3m0.svg?style=flat-square)](https://github.com/andreped/postly/blob/main/LICENSE.md)
18
+ <a target="_blank" href="https://huggingface.co/spaces/andreped/postly"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
19
+
20
  This repository contain the Postly client, which serves as a micro-message communication platform, similar to Twitter.
21
 
22
+ To access the live demo, click on the `Hugging Face` badge above. Below is a snapshot of the current state of the demo app.
23
 
24
+ <img width="1400" alt="Screenshot" src="https://github.com/andreped/assets/postly_image.png">
25
+
26
+ ## Getting started
27
 
28
+ Install dependencies:
29
+ ```
30
+ pip install -r requirements.txt
31
  ```
 
32
 
33
+ Run streamlit app:
34
+ ```
35
+ streamlit run app.py
36
  ```
37
 
38
  ## Testing
 
42
  | Build Type | Status |
43
  | - | - |
44
  | **Unit tests** | [![CI](https://github.com/andreped/postly/workflows/Tests/badge.svg)](https://github.com/andreped/postly/actions) |
45
+ | **Check file size** | [![CI](https://github.com/andreped/postly/workflows/Check%20file%20size/badge.svg)](https://github.com/andreped/postly/actions) |
46
+ | **Unit tests** | [![CI](https://github.com/andreped/postly/workflows/Deploy/badge.svg)](https://github.com/andreped/postly/actions) |
47
 
48
  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:
49
  ```
assets/streamlit-app-demo.png ADDED