{ "info": { "author": "Ang Ray Yan", "author_email": "ang.ray.yan@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "## Ary's Box (abox)\n\n[![Build Status](https://travis-ci.org/4rr4y/abox.svg?branch=master)](https://travis-ci.org/4rr4y/abox)\n[![Coverage Status](https://coveralls.io/repos/github/4rr4y/abox/badge.svg?branch=master)](https://coveralls.io/github/4rr4y/abox?branch=master)\n\n\n[Documentation](https://angrayyan.net/abox)\n\nWorks In Progress. Done by Ang Ray Yan.\n\n### User Note\n\n#### U1. Installation\n\nInstallation using `pip` is the fastest way to go about getting `abox`:\n```shell\npip install abox\n```\n\n#### U2. Getting Started\n\nAn example of what you could do with `abox` is as follows:\n```python\nimport abox\ntree = abox.AVLTree()\nfor i in range(1, 16):\n tree.insert(i)\nprint('Tree Height (1-based): ', tree.get_height())\nprint('Preorder Traversal: ', tree.pre_order())\nprint('Inorder Traversal: ', tree.in_order())\n```\n\nAnd the output is (hopefully) what you would expect :)\n```\nTree Height (1-based): 4\nPreorder Traversal: [8, 4, 2, 1, 3, 6, 5, 7, 12, 10, 9, 11, 14, 13, 15]\nInorder Traversal: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]\n```\n\nDo refer to the [documentation](https://angrayyan.net/abox) for more details!\n\n### Developer Note\n\n`pip3` and `pip`, as well as `python3` and `python` are used interchangeably here.\n\n#### D1. Installing required dependencies\n\nFirstly, install all required dependencies (within the root directory):\n```shell\npip3 install -r requirements.txt\n```\n\n#### D2. Testing\n\nTo run all tests, use the following command (in root directory too):\n```shell\npython3 -m pytest tests/ --cov=abox/\n```\n\nIf necessary, you can generate a html report (to be stored in htmlcov/ directory)for coverage report instead as follows:\n```shell\npython3 -m pytest tests/ --cov=abox/ --cov-report html\n```\n\n#### D3. Generating Documentation\n\nTo rebuild documentation using Sphinx, you may run the following (in root directory):\n```shell\nsphinx-build -b html docs docs/_build\n```\n\n#### D4. Packaging/Releasing on PyPI\n\nRun the following command to generate distribution packages:\n```shell\npython3 setup.py sdist bdist_wheel\ntwine upload dist/*\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/4rr4y/abox", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "abox", "package_url": "https://pypi.org/project/abox/", "platform": "", "project_url": "https://pypi.org/project/abox/", "project_urls": { "Homepage": "https://github.com/4rr4y/abox" }, "release_url": "https://pypi.org/project/abox/0.2/", "requires_dist": null, "requires_python": "", "summary": "A multi-purpose python package mainly for educational purposes", "version": "0.2" }, "last_serial": 5557719, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "7894c08f7099a0485ce804a4985b9113", "sha256": "12ecb8c81e99a5ff43814cd1e68600b9a663f330d8b6ca108e53e82bcbcfbcf4" }, "downloads": -1, "filename": "abox-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "7894c08f7099a0485ce804a4985b9113", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 41937, "upload_time": "2019-07-19T13:51:29", "url": "https://files.pythonhosted.org/packages/99/8a/28129cf44d096fa2f5ce7133a577ac962713141428f24eaf7a9370a6df7e/abox-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b5a33f0e51a8333019fdca124728d57f", "sha256": "e4750016f88745a937c69abea2b32bcc3c8604ab263861b77fc9cf443febb84e" }, "downloads": -1, "filename": "abox-0.1.tar.gz", "has_sig": false, "md5_digest": "b5a33f0e51a8333019fdca124728d57f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9802, "upload_time": "2019-07-19T13:51:31", "url": "https://files.pythonhosted.org/packages/54/ed/4fef8132971ea6ad078f94304f17e3f873201995a53440a3f2acb014524c/abox-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "176aec80aae6497d48a1957c2c269d20", "sha256": "6b04ce5c4befbd9e7a58c8dbb3e65859576e8a2fcf27ef04b095249be5aadb03" }, "downloads": -1, "filename": "abox-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "176aec80aae6497d48a1957c2c269d20", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 44524, "upload_time": "2019-07-19T17:30:32", "url": "https://files.pythonhosted.org/packages/aa/fb/1f4fc1e37d43535c1de0928595f5b0bd965a095dad8d73b88baf19462d2a/abox-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7793220f87e1ee0d27e6de2b12af1a28", "sha256": "27662c1b308e06a57b4a6e6105a8558e27e621e0c91d860e6700187c1cf616c1" }, "downloads": -1, "filename": "abox-0.2.tar.gz", "has_sig": false, "md5_digest": "7793220f87e1ee0d27e6de2b12af1a28", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12013, "upload_time": "2019-07-19T17:30:34", "url": "https://files.pythonhosted.org/packages/d4/b9/4f5afedb35a2dee7ca4e860a754ec94d1fee2a0786438b5264c458f2b42e/abox-0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "176aec80aae6497d48a1957c2c269d20", "sha256": "6b04ce5c4befbd9e7a58c8dbb3e65859576e8a2fcf27ef04b095249be5aadb03" }, "downloads": -1, "filename": "abox-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "176aec80aae6497d48a1957c2c269d20", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 44524, "upload_time": "2019-07-19T17:30:32", "url": "https://files.pythonhosted.org/packages/aa/fb/1f4fc1e37d43535c1de0928595f5b0bd965a095dad8d73b88baf19462d2a/abox-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7793220f87e1ee0d27e6de2b12af1a28", "sha256": "27662c1b308e06a57b4a6e6105a8558e27e621e0c91d860e6700187c1cf616c1" }, "downloads": -1, "filename": "abox-0.2.tar.gz", "has_sig": false, "md5_digest": "7793220f87e1ee0d27e6de2b12af1a28", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12013, "upload_time": "2019-07-19T17:30:34", "url": "https://files.pythonhosted.org/packages/d4/b9/4f5afedb35a2dee7ca4e860a754ec94d1fee2a0786438b5264c458f2b42e/abox-0.2.tar.gz" } ] }