Skip to content

andreped/postly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

title colorFrom colorTo sdk sdk_version python_version app_port emoji pinned license app_file
Postly: a simple twitter clone
indigo
indigo
streamlit
1.39.0
3.10
7860
🫁
false
mit
app.py

Postly

license

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

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

Screenshot

Getting started

Install dependencies:

pip install -r requirements.txt

Run streamlit app:

streamlit run app.py

Testing

For this project, we perform continuous integration to make sure that code is tested and formatted appropriately:

Build Type Status
Unit tests CI
Check file size CI
Unit tests CI

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:

python -m venv venv/
source venv/bin/activate

pip install -r requirements.txt

Then run this command to perform unit tests:

pytest -v tests/

To perform formatting checks, run the following:

sh shell/lint.sh

License

This project has MIT license.