Skip to content

sami-dca/sami_dca

Repository files navigation

Python version: 3.10 License: MIT Code style: black

Sami is a decentralized communication application, written in Python, and available for free on GitHub!

Similar to apps like Whatsapp and Telegram, it aims at providing an enjoyable messaging experience while relying on strong cryptography and a decentralized (peer-to-peer) model for maximum anonymity and security!

For a detailed description of how the system works, please refer to the Sami Paper.

Installation

Standard user

Stable and ready-to-use versions are available in the releases page.


Currently, to set up Sami, you will need Python 3.10 or above. You can download a copy from https://python.org

Note: if you're already using Python, we advise you use a virtual environment for this next part, otherwise no worries !

Finally, to get it to work, install the dependencies: on Windows, run the script setup_windows.bat.

After that, you should be able to run sami.py.

PS: we are currently working on providing executables (e.g. .exe) to simplify the installation process

Contributing

If you wish to contribute to the project, please first review our guidelines.

Development

To start working on the project, clone the repo with:

git clone https://github.com/sami-dca/sami_dca

For this next part, using a Python virtual environment is strongly recommended.

Next, install the usual dependencies using

pip install -r requirements.txt

and the development dependencies with

pip install -r requirements_dev.txt