{ "info": { "author": "Jenson Jose", "author_email": "jensonjose@live.in", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Topic :: Software Development", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Utilities" ], "description": "# UtilBox README\n\n> `utilbox` is a collection of Python utility packages to help you save time and avoid writing code for commonly\nrequired tasks.\n\nThe current set of utilities cover the following areas:\n\n* Encryption\n* JSON manipulation\n* Sending Email\n* Number manipulations\n* File, directory manipulations\n* System interaction\n* Spreadsheet (Excel, CSV) manipulation\n* String and multi-line text manipulation\n \nAn overview of the available packages is tabulated as below.\n\nPackage | Class | Description\n--- | --- | ---\ncrypt_utils | CryptUtils | Encrypt data with AES-128/192/256-bit encryption\njson_utils | JsonUtils | Convert data to `JSON` formatted string\nmail_utils | MailUtils | Send a plain-text or HTML-formatted email using Python `smtplib` or external mail application (CLI)\nnumber_utils | NumberUtils | Perform various operations with numbers and numeric lists\nos_utils | SysUtils, FileUtils, DirUtils | Manipulate files, directories and interact with the underlying OS\nspreadsheet_utils | ExcelUtils, CsvUtils | Work with spreadsheets and CSV files\nstring_utils | StringUtils, TextUtils | Manipulate strings and multi-line text\n\n## Installation\n\n### Install using `pip`\n\nMake sure you have `pip` installed on your system, and then run:\n\n```pip install utilbox```\n\n### Install from sources\n\n* Download the [latest release] from `GitHub` and extract it to a temporary location\n* Open your terminal and `cd` to the extracted archive directory\n* Run `python setup.py install`\n\n### Dependencies\n\nPackage dependencies are listed in `requirements.txt`.\n\n## Usage\n\nThe below rule should be applied in general when trying to use a utility class,\n\n> from utilbox.** import **\n\nFor example to use the `FileUtils` class from `os_utils` package,\n\n> from utilbox.*os_utils* import *FileUtils*\n\nHere are some real-world scenarios where `utilbox` can serve your purposes,\n\n### Example 1\nLet's say you want to fetch only the last line of some text file. To do this,\n\n```python\nfrom utilbox.os_utils import FileUtils\n\nlast_line = FileUtils.get_file_last_line(\"path/to/file.ext\")\nprint last_line\n```\n\n### Example 2\nWhat if you wanted the epoch time? No worries,\n\n```python\nfrom utilbox.os_utils import SysUtils\n\nepoch_time = SysUtils.get_epoch_time()\nprint epoch_time\n```\n\n### Example 3\nYou can send an email just as easily,\n\n```python\nfrom utilbox.mail_utils import MailUtils\n\nsmtp_server = \"192.168.0.1\"\nsender_email_id = \"someguy@example.com\"\n\nmailer = MailUtils(smtp_server, sender_email_id)\n\n# send a plain-text message\nmailer.send_mail_plain(\"receiver@example2.com\", \"This is a test mail\", sender_email_id, \"This message was brought to you by 'utilbox'!\")\n\n# send an HTML message\nmailer.send_mail_plain(\"receiver@example2.com\", \"This is a test mail\", sender_email_id, \"This message was brought to you by 'utilbox'!\")\n```\n\n`utilbox` is being updated constantly, so feel free to send in any suggestions for new features or issues with existing ones. Enjoy! \n\n## Release history\n\nRelease history is available in `CHANGELOG.md`.\n\n## License\n\nSee `LICENSE.txt` for license information.\n\n## Author\n\n[Jenson Jose] \nFollow me [@JoseJenson] \nSend your suggestions / feedback at `jensonjose@live.in`\n\n### How to contribute\n\nTo contribute, simply:\n\n* Fork the project\n* Create your feature branch\n* Commit your changes\n* Push committed changes to your branch\n* If you're happy and you know it, create a new `PULL` request\n\n[latest release]: https://github.com/jensonjose/utilbox/releases/latest\n[Jenson Jose]: https://www.jensonjose.com\n[@JoseJenson]: https://twitter.com/JoseJenson", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jensonjose/utilbox", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "utilbox", "package_url": "https://pypi.org/project/utilbox/", "platform": "Any", "project_url": "https://pypi.org/project/utilbox/", "project_urls": { "Homepage": "https://github.com/jensonjose/utilbox" }, "release_url": "https://pypi.org/project/utilbox/0.1.6/", "requires_dist": null, "requires_python": "", "summary": "Collection of utility packages for Python.", "version": "0.1.6" }, "last_serial": 3007609, "releases": { "0.1.6": [ { "comment_text": "", "digests": { "md5": "182473b8b4552ed59cb88b311d9611a4", "sha256": "d8288a400da29814c94237d7e21099797611d0dda466b702bbbfbc5aa70e8a3c" }, "downloads": -1, "filename": "utilbox-0.1.6.tar.gz", "has_sig": false, "md5_digest": "182473b8b4552ed59cb88b311d9611a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17454, "upload_time": "2017-07-08T00:11:22", "url": "https://files.pythonhosted.org/packages/6b/40/db2824c8a86481d16334a41715dfaaad0a452360bae8373395870de48e51/utilbox-0.1.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "182473b8b4552ed59cb88b311d9611a4", "sha256": "d8288a400da29814c94237d7e21099797611d0dda466b702bbbfbc5aa70e8a3c" }, "downloads": -1, "filename": "utilbox-0.1.6.tar.gz", "has_sig": false, "md5_digest": "182473b8b4552ed59cb88b311d9611a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17454, "upload_time": "2017-07-08T00:11:22", "url": "https://files.pythonhosted.org/packages/6b/40/db2824c8a86481d16334a41715dfaaad0a452360bae8373395870de48e51/utilbox-0.1.6.tar.gz" } ] }