{ "info": { "author": "Evgeny Kuleshov", "author_email": "kulevgen32@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", "Topic :: Communications :: Chat" ], "description": "

TuiChat

\n\n

\n \"Built\n \"License\n \"Contributors\"\n \"Release\"\n \"Repo\n
\n \"Open\n \"Closed\n \"Downloads\"\n \"Codacy\n

\n

A simple messaging program

\n\n---\n## Table of Contents\n- [Code of Conduct](documentation/CODE_OF_CONDUCT.md)\n\n- **Installing**\n - [Installing (\u21161) compiled files](#installing-1-compiled-files)\n - [Installing (\u21162) pip](#installing-2-pip)\n - [Installing (\u21163) from sources](#installing-3-from-sources)\n - [Installing (\u21164) compilation guide](#installing-4-compilation-guide)\n\n- **User's manual**\n - [User's manual (host)](#users-manual-host-or-server-holder)\n - [User's manual (client)](#users-manual-client)\n\n- **Configuration**\n - [Configuration file description](#configuration-file-description)\n\n- **Other info**\n - [Contributing](#contributing)\n - [Authors](#authors)\n - [Tools](#built-with)\n - [Versioning](#versioning)\n - [License](#license)\n\n## Getting Started\n\n> These instructions will get you a copy of the project up and running on your local machine for development. See deployment for notes on how to deploy the project on a live system.\n\n### Installing (\u21161) compiled files\n\n> Go to [releases](https://github.com/Kukree/tuichat/releases)\n\n> Download archive with files and unzip it to any directory\n\n### Installing (\u21162) pip\n\n> Run this command in your shell:\n\n```Bash\npip install tuichat\n```\n\n### Installing (\u21163) from sources\n\n> Setup Git and type in git bash:\n\n```Bash\ngit clone https://github.com/Kukree/tuichat\n```\n\n> Install [**Python 3**](https://python.org) if not installed or compile program files with your program to compile **(Pyinstaller, wheel, etc)**, the following lines are a program compilation guide\n\n### Installing (\u21164) compilation guide\n\n> Go to program directory\n\n> Run the following commands one at a time in your shell:\n\n```Bash\npip install pyinstaller\n\npyinstaller --onedir --onefile server.py\n\npyinstaller --onedir --onefile client.py\n```\n\n### User's manual (host, or server holder)\n\n#### Configure\n> Enter settings into **config.json** file and save it\n\n> **config.json**\n\n![Configuring server](https://imgur.com/wlny9ET.gif)\n\n> **Note**: If you have problems with configuring, look at [configuration file description](#configuration-file-description)\n\n> **Note 2**: If you don't want to use **config.json** you can delete it and configure program at startup\n\n#### Running\n> Run **server.exe** (on info table you will see information about your server, running port, limit of connections, external IP address, TUI graphics, logging and others)\n\n> Give your **external IP address** to clients and **connection port**, written in server info table\n\n### User's manual (client)\n\n> Run **client.exe**\n\n> Enter **IP address** of server and press **ENTER**\n\n> Enter **connection port** of server and press **ENTER**\n\n> Enjoy :)\n\n![Client connecting](https://imgur.com/OtCQgVH.gif)\n\n---\n\n## Configuration file description\n\n- `max_connections` - Variable used for set a limit of connections to server\n\n- `port` - Port to connect to your server, users will type it in client\n\n- `enable_log` (True/false) - Enable or disable saving logs of messages/connections or disconnections/other things, happened on server\n\n- `enable_ui` (True/false) - Enable or disable special UI symbols, like: logo, lines for highlighting system messages, borders around license block\n\n## Contributing\n\n> To get started...\n\n### Step 1\n\n- **Option 1**\n - \ud83c\udf74 Fork this repo!\n\n- **Option 2**\n - \ud83d\udc6f Clone this repo to your local machine using `https://github.com/Kukree/tuichat.git`\n\n### Step 2\n\n- **HACK AWAY!** \ud83d\udd28\ud83d\udd28\ud83d\udd28\n\n### Step 3\n\n- \ud83d\udd03 Create a new pull request using `https://github.com/Kukree/tuichat/compare/`.\n\n---\n\n## Built With\n\n- [Python](https://python.org) - Programming language\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Kukree/tuichat/tags).\n\n## Authors\n\n- **Evgeniy Kuleshov** - *Initial work* - [Greenfield](https://github.com/Kukree)\n\nSee also the list of [contributors](https://github.com/Kukree/tuichat/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the GNU GPLv3 - see the [LICENSE](documentation/LICENSE) file for details\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kukree/tuichat", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "tuichat", "package_url": "https://pypi.org/project/tuichat/", "platform": "", "project_url": "https://pypi.org/project/tuichat/", "project_urls": { "Homepage": "https://github.com/kukree/tuichat" }, "release_url": "https://pypi.org/project/tuichat/0.6.3/", "requires_dist": [ "importlib.resources", "tqdm" ], "requires_python": "", "summary": "A simple messaging program and API", "version": "0.6.3" }, "last_serial": 5511066, "releases": { "0.6.1": [ { "comment_text": "", "digests": { "md5": "fe1c2dbf978526f8ccd19d4c26be86de", "sha256": "83132d41fc87b1cf681bb5f3b65d77bba1ad76f23a3da171f057a23bb0a155cf" }, "downloads": -1, "filename": "tuichat-0.6.1.tar.gz", "has_sig": false, "md5_digest": "fe1c2dbf978526f8ccd19d4c26be86de", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13436, "upload_time": "2019-06-21T08:40:52", "url": "https://files.pythonhosted.org/packages/3e/80/37c95241826f921d5d703f655faa5bf5214e1868526d6b867af6d3d662c2/tuichat-0.6.1.tar.gz" } ], "0.6.2": [ { "comment_text": "", "digests": { "md5": "1a3ad6504fbf799cb478879da8d09d44", "sha256": "bf8c8fb747cba0ec8c3186028e3b094a6dd091353e2125977b69ca7f8c3eb5f4" }, "downloads": -1, "filename": "tuichat-0.6.2-py3-none-any.whl", "has_sig": false, "md5_digest": "1a3ad6504fbf799cb478879da8d09d44", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15211, "upload_time": "2019-07-08T18:47:10", "url": "https://files.pythonhosted.org/packages/7d/7e/379c1934c3a807d5b5524c81bb0d14321b629fd9dd55966f560b98a1f69b/tuichat-0.6.2-py3-none-any.whl" } ], "0.6.3": [ { "comment_text": "", "digests": { "md5": "46085c312c7e251eef4e93b78b8e763c", "sha256": "a4cee64989b857831a627c1375b3bce665a93b7b3f91b49d08996c70da2dac7c" }, "downloads": -1, "filename": "tuichat-0.6.3-py3-none-any.whl", "has_sig": false, "md5_digest": "46085c312c7e251eef4e93b78b8e763c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15463, "upload_time": "2019-07-10T09:38:02", "url": "https://files.pythonhosted.org/packages/1a/00/176f27d11d63a9f2c1144a9cf914fcfad864f124e93a58cd0d3fe7d7ccaf/tuichat-0.6.3-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "46085c312c7e251eef4e93b78b8e763c", "sha256": "a4cee64989b857831a627c1375b3bce665a93b7b3f91b49d08996c70da2dac7c" }, "downloads": -1, "filename": "tuichat-0.6.3-py3-none-any.whl", "has_sig": false, "md5_digest": "46085c312c7e251eef4e93b78b8e763c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15463, "upload_time": "2019-07-10T09:38:02", "url": "https://files.pythonhosted.org/packages/1a/00/176f27d11d63a9f2c1144a9cf914fcfad864f124e93a58cd0d3fe7d7ccaf/tuichat-0.6.3-py3-none-any.whl" } ] }