{ "info": { "author": "Haider Ali", "author_email": "haider.lee23@gmail.com", "bugtrack_url": null, "classifiers": [ "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# tmessage\n## This is a lightweight and low bandwidth CLI tool which can be used for group communication right from your terminal (isn't this cool ; ) )\n\n\n![Hacktoberfest 2019 presented by DigitalOcean and DEV](https://hacktoberfest.digitalocean.com/assets/logo-hf19-header-8245176fe235ab5d942c7580778a914110fa06a23c3d55bf40e2d061809d8785.svg)\n### Contributions are welcome for [Hacktoberfest 2019](https://hacktoberfest.digitalocean.com/) (Presented by DigitalOcean and DEV). Search for issues labeled [`Hacktoberfest`](https://github.com/Haider8/tmessage/issues?q=is%3Aopen+is%3Aissue+label%3AHacktoberfest).\n\n* [Our Contributing Guidelines](https://github.com/Haider8/tmessage/blob/master/CONTRIBUTING.md)\n* [Our Code of Conduct](https://github.com/Haider8/tmessage/blob/master/CODE_OF_CONDUCT.md)\n\n### Installation instructions\n\n* Clone this project using the command ```git clone https://github.com/Haider8/tmessage.git```\n* Setup your python3 virtual environment using this command ```virtualenv -p python3 venv```\n* Switch to your venv using ```source venv/bin/activate```\n* Now install the required dependencies by running ```pip install .```\n* Now to run tmessage use ```tmessage --user [YOUR USERNAME] --port [PORT (optional)] --server [YOUR BROKER IP OR URL (optional)]```\n* To test this you can open different terminal tabs.\n\n### Some optional instructions for PROs ;)\n* If you don't want to create your own broker it's perfectly fine as tmessage is using a default broker ```test.mosquitto.org```. Therefore, you can then run tmessage using ```python msg.py --user [YOUR USERNAME]```.\n\n* If you happen to use this on a different port, it can be specified as - \n```tmessage --user [USERNAME] --port [PORT]```. If omitted, it defaults to 1883.\n\n* This project uses an [API](https://github.com/Haider8/tmessage-api) for the authentication of users. Default API Url is [this](https://peaceful-waters-15584.herokuapp.com). If you want to use your own authentication API you can deploy our [tmessage-api](https://github.com/Haider8/tmessage-api) locally(for testing) or on some cloud (the default API is hosted on Heroku). Then, you can set that Url in `.env` file like this `TMESSAGE_API_URL=http://localhost:8080` or `TMESSAGE_API_URL=`.\n\n\n### Development Instructions\n\n* You can first fork tmessage and can then clone using command ```git clone https://github.com/[YOUR USERNAME]/tmessage.git```\n* Please send PRs using new branch and not master\n* Commit message should perfectly describe the code changes done by you\n\n*Would love to hear any suggestions, feedback, feature requests or any other issue*", "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/Haider8/tmessage", "keywords": "", "license": "GPL-3.0", "maintainer": "", "maintainer_email": "", "name": "tmessage", "package_url": "https://pypi.org/project/tmessage/", "platform": "", "project_url": "https://pypi.org/project/tmessage/", "project_urls": { "Homepage": "https://github.com/Haider8/tmessage" }, "release_url": "https://pypi.org/project/tmessage/0.0.2/", "requires_dist": null, "requires_python": ">=3.4", "summary": " This is a lightweight and low bandwidth CLI tool which can be used for group communication right from your terminal. ", "version": "0.0.2" }, "last_serial": 5937900, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "b4f82f686c704a94d56be24457fcb1dd", "sha256": "5d34883edc3f690987ed9f873f5faf3041972ff8ed525e9a42ca6320f27aefef" }, "downloads": -1, "filename": "tmessage-0.0.1.tar.gz", "has_sig": false, "md5_digest": "b4f82f686c704a94d56be24457fcb1dd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 4499, "upload_time": "2019-10-07T09:31:17", "url": "https://files.pythonhosted.org/packages/df/d0/6553321964e4552e662069a9f08df0e9d7b970a2edbf554d99b0839c5787/tmessage-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "cc829b0b077034dddf2bfa18553ebf39", "sha256": "119a60c60c2ef72678b3c9ab0777a40152777db4fa5520d4ab55ab40a6ac236b" }, "downloads": -1, "filename": "tmessage-0.0.2.tar.gz", "has_sig": false, "md5_digest": "cc829b0b077034dddf2bfa18553ebf39", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 4513, "upload_time": "2019-10-07T09:44:16", "url": "https://files.pythonhosted.org/packages/bc/06/17df25cc781a612307ec0a20e79ad26f6517b57fa5c045f57d8e0690c2ea/tmessage-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cc829b0b077034dddf2bfa18553ebf39", "sha256": "119a60c60c2ef72678b3c9ab0777a40152777db4fa5520d4ab55ab40a6ac236b" }, "downloads": -1, "filename": "tmessage-0.0.2.tar.gz", "has_sig": false, "md5_digest": "cc829b0b077034dddf2bfa18553ebf39", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 4513, "upload_time": "2019-10-07T09:44:16", "url": "https://files.pythonhosted.org/packages/bc/06/17df25cc781a612307ec0a20e79ad26f6517b57fa5c045f57d8e0690c2ea/tmessage-0.0.2.tar.gz" } ] }