Socks is Python based instant messaging application that uses Flask & SocketIO.
To run this application install the requirements in a virtual environment, run python chat.py
and visit http://localhost:5000 on one or more browser tabs.
$ python chat.py
| Project | Version | Usage |
|---|---|---|
| Socket.IO | 1.3.6 | Sending messages |
| markdown-it | 10.0.0 | Rendering Markdown sent in messages |
| Highlight.js | 9.15.10 | Highlighting syntax in markdown messages |
To start contributing to the project, I highly recommend using a tool like Pipenv. All examples here will be given using Pipenv.
- Clone the repository
- Install necessary packages
pipenv install
- Setup git hooks to auto-format code (consistency is king)
pipenv run autohooks activate
To ensure a consistent format for all systems, Autohooks has been used. In order to automatically install the necessary git pre-commit hook, simply run the command:
$ pipenv run autohooks activate
If Autohooks does not work for you (it may not work on all operating systems yet),
please copy the file formatting/pre-commit to your .git/hooks/ directory to preserve
autopep8 formatting.
**Note: You must have autopep8 installed globally for Python 3.6