Skip to content
forked from code-zm/nymChat

Python Messaging Client for secure communication over the Nym Mixnet.

Notifications You must be signed in to change notification settings

itsz3us/nymChat

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

nymChat


Python Messaging Client for secure messaging over the Nym Mixnet, a decentralized network designed for privacy.

alt text

Prerequisites


Setting up nym-client

  1. Download and make executable:
  • Once you've downloaded the nym-client file, navigate (cd) to its location in the terminal.
  • Make it executable by running: sudo chmod +x nym-client
  1. Initialize the client:
  • Initialize the client with a unique ID by running: ./nym-client init --id name
  • Replace name with any identifier you'd like to use for your client.
  1. Run the client:
  • Start the client by running: ./nym-client run --id name
  • Replace name with the identifier you used during initialization.

Once you see the message > Client startup finished!, you’ll know the Nym client is ready. Keep this terminal running, and open a new terminal for the next steps.


Running nymChat.py

  1. Set up your Python environment:
  • Clone this repository and navigate to the directory:
git clone https://github.com/code-zm/nymChat.git
cd nymChat
  1. Create Virutal Environment
  • Run these commands to create and activate a virtual environment:
python3 -m venv venv
source venv/bin/activate
  1. Install Dependencies:
  • Install required dependencies by running: pip install -r requirements.txt
  1. Run the Script:
  • In a new terminal, run the Python script python nymChat.py
  1. Enter recipient's Nym address:
  • When prompted, enter the Nym address of the recipient you wish to communicate with.

Script Overview

  • Sending Messages: Enter your message when prompted. To exit the messaging loop, type 'exit'.
  • Receiving Messages: The script will display incoming messages from the Nym network in real-time.

Troubleshooting

If you encounter any connection issues, verify that:

  • The Nym client is running and accessible in the background.
  • The WebSocket URI (ws://127.0.0.1:1977) in nymChat.py matches the Nym client’s configuration.
  • Try restarting the nym-client if you run into issues! CTRL + C to stop it.

License

This project is licensed under the MIT License.

About

Python Messaging Client for secure communication over the Nym Mixnet.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%