{ "info": { "author": "Sanhe Hu", "author_email": "husanhe@me.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": ".. image:: https://travis-ci.org/MacHu-GWU/elementary_math-project.svg?branch=master\r\n :target: https://travis-ci.org/MacHu-GWU/elementary_math-project?branch=master\r\n\r\n.. image:: https://codecov.io/gh/MacHu-GWU/elementary_math-project/branch/master/graph/badge.svg\r\n :target: https://codecov.io/gh/MacHu-GWU/elementary_math-project\r\n\r\n.. image:: https://img.shields.io/pypi/v/elementary_math.svg\r\n :target: https://pypi.python.org/pypi/elementary_math\r\n\r\n.. image:: https://img.shields.io/pypi/l/elementary_math.svg\r\n :target: https://pypi.python.org/pypi/elementary_math\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/elementary_math.svg\r\n :target: https://pypi.python.org/pypi/elementary_math\r\n\r\n.. image:: https://img.shields.io/badge/Star_Me_on_GitHub!--None.svg?style=social\r\n :target: https://github.com/MacHu-GWU/elementary_math-project\r\n\r\n.. contents::\r\n\r\n\r\nWelcome to ``elementary_math`` Documentation\r\n============================================\r\n``elementary_math`` is a project to demonstrate: how to setup environment and toolsets for a python library project on github, includes these **powerful components**:\r\n\r\n- virtual environment setup (one command install everything)\r\n- setup.py file (one click **install**/**uninstall**)\r\n- auto Google stylize your code\r\n- fancy sphinx document (one click **build**/**view**/**deploy**)\r\n- unittest suits with pytest\r\n- code coverage test with coverall\r\n- multi python version test with tox\r\n- integration with https://travis-ci.org/\r\n- integration with https://codecov.io/\r\n- auto deploy to `AWS S3 `_\r\n- publish to `PyPI `_\r\n\r\n\r\nQuick Links\r\n-----------\r\n- `GitHub Homepage `_\r\n- `Online Documentation `_\r\n- `PyPI download `_\r\n- `Install `_\r\n- `Issue submit and feature request `_\r\n- `API reference and source code `_\r\n\r\n\r\nUsage\r\n-----\r\n1. Clone the repo.\r\n2. Navigate to ``elementary_math-project/start-a-project``, edit ``init_project.py`` and run it.\r\n3. A ```` directory will be created, you can use this as your github repo directory.\r\n4. Take a look at ``Makefile``, all magic happens here!\r\n\r\n\r\nAWS Command Line (Optional)\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nUse `AWS S3 `_ to host your doc site is a good idea!\r\n\r\nWe need `awscli `_ to automate the deployment.\r\n\r\n1. Install `awscli `_, just ``pip install awscli``.\r\n2. `Configure your API token `_, just ``aws configure`` and follow the instruction.\r\n\r\n\r\nConfig PyPI (Optional)\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nIf you want to publish your package to `PyPI `_ or `new PyPI `_, you need a pypi account and `Configure your credential `_.\r\n\r\n1. Create a ``${HOME}/.pypirc`` file.\r\n2. put these contents::\r\n\r\n [distutils]\r\n index-servers =\r\n pypi\r\n\r\n [pypi]\r\n username:\r\n password:\r\n\r\n\r\nCI (Continues Integration) (Optional)\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\n1. `Test with travis-ci `_, basically you just need to:\r\n - sign in using GitHub account.\r\n - toggle on your repo.\r\n2. `Code Coverage Test with codecov `_.\r\n\r\n\r\nFor Windows\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nBecause Windows doesn't have ``shell script`` and ``make`` command, so we have to install some third-party software to make it works.\r\n\r\n**Install Git Bash as shell emulator**\r\n\r\n1. `Download and install git `_.\r\n2. Now you can use ``C:\\Program Files\\Git\\git-bash.exe`` like the terminal in MacOS/Linux.\r\n\r\n**Install MinGW**\r\n\r\n1. `Download and install `_, use the installer to install ``MinGW Base``.\r\n2. Find ``C:\\MinGW\\bin\\mingw32-make.exe``, copy and paste and rename as ``C:\\MinGW\\bin\\make.exe``.\r\n3. Add ``C:\\MinGW\\bin`` to $PATH (environment variable).\r\n\r\nNow you can use ``make `` in ``git-bash.exe`` now.\r\n\r\n\r\nFor MacOS\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nYou have to make sure:\r\n\r\n- `HomeBrew `_ is installed.\r\n\r\nThere's two way of using virtualenv in MacOS:\r\n\r\n1. Use generic `virtualenv `_.\r\n2. Use `pyenv `_ + `pyenv-virtualenv `_.\r\n\r\nI prefer ``pyenv`` + ``pyenv-virtualenv``, because it allows you:\r\n\r\n1. use tox to test against multiple python version locally before using cloud CI (continues integration).\r\n2. will not mess up your global python environment.\r\n3. the ``Makefile`` will do the ``pyenv`` + ``pyenv-virtualenv`` setup for you, just make sure that you have `HomeBrew `_ installed.\r\n\r\n\r\n.. _install:\r\n\r\nInstall\r\n-------\r\n\r\n``elementary_math`` is released on PyPI, so all you need is:\r\n\r\n.. code-block:: console\r\n\r\n $ pip install elementary_math\r\n\r\nTo upgrade to latest version:\r\n\r\n.. code-block:: console\r\n\r\n $ pip install --upgrade elementary_math\r\n\r\n", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/MacHu-GWU//tarball/2017-09-07", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/MacHu-GWU/", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "elementary_math", "package_url": "https://pypi.org/project/elementary_math/", "platform": "Windows", "project_url": "https://pypi.org/project/elementary_math/", "project_urls": { "Download": "https://github.com/MacHu-GWU//tarball/2017-09-07", "Homepage": "https://github.com/MacHu-GWU/" }, "release_url": "https://pypi.org/project/elementary_math/0.0.8/", "requires_dist": null, "requires_python": "", "summary": "Elementary Mathematics.", "version": "0.0.8" }, "last_serial": 3155621, "releases": { "0.0.1": [], "0.0.2": [ { "comment_text": "", "digests": { "md5": "40e906291be341dd0da16e63bc1ae035", "sha256": "09c8a6fb74d601f5c73f3718bb1bbdaf54c597e450d86aa0bd602ebaf6b07ee4" }, "downloads": -1, "filename": "elementary_math-0.0.2.zip", "has_sig": false, "md5_digest": "40e906291be341dd0da16e63bc1ae035", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11744, "upload_time": "2016-06-03T16:36:37", "url": "https://files.pythonhosted.org/packages/eb/cc/e6d1a7e50f042422e0dc344df0809261a5a3a1a6dcb2f8afbc834f848995/elementary_math-0.0.2.zip" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "3ce7f5e71343fc6b4e4eeb04baa5b2b4", "sha256": "a2b1945d289299791ee685ed11ae89055735c1068449b0686ddeda768957b8e8" }, "downloads": -1, "filename": "elementary_math-0.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "3ce7f5e71343fc6b4e4eeb04baa5b2b4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 10630, "upload_time": "2017-07-18T06:01:36", "url": "https://files.pythonhosted.org/packages/44/7e/6aae9af2fb9c16fed0bffa046c6f5784e28d23050580d5ef26d69c64c3fe/elementary_math-0.0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5cd5a7152f17b347a8e2dd0cee5a75d3", "sha256": "5104cb45020b4ecfc201a7bd6d85b081dea6f952647209bb01a73d80d47dc79c" }, "downloads": -1, "filename": "elementary_math-0.0.3.tar.gz", "has_sig": false, "md5_digest": "5cd5a7152f17b347a8e2dd0cee5a75d3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6922, "upload_time": "2017-07-18T05:57:44", "url": "https://files.pythonhosted.org/packages/72/0b/3067632b0062bb794c765078e1bd25ace785bc3dffbc9c78b7a41845a762/elementary_math-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "888e6ed9f04397772c2c99478b298628", "sha256": "654909fed37355d0b5e8657257cdaef34b9490dd4ecf1a5b6d019fa956ed0a5d" }, "downloads": -1, "filename": "elementary_math-0.0.4-py2-none-any.whl", "has_sig": false, "md5_digest": "888e6ed9f04397772c2c99478b298628", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6994, "upload_time": "2017-08-30T22:35:55", "url": "https://files.pythonhosted.org/packages/21/7c/484bb7a76c7a5dc5c785724b4b7ba8dcb8e6f5c425917f25b0977c55df0e/elementary_math-0.0.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8b13dddb3f2a7cc1a387c2685c174807", "sha256": "e3e8df5ee21010082eb9855f88d4dc2441b8bac0c04e1c2dfad26f136fcd768a" }, "downloads": -1, "filename": "elementary_math-0.0.4.tar.gz", "has_sig": false, "md5_digest": "8b13dddb3f2a7cc1a387c2685c174807", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5201, "upload_time": "2017-08-30T22:35:57", "url": "https://files.pythonhosted.org/packages/ea/a8/c7b77dab905e66bb2dbb2f192c4192887d3469a8368504a440884f90f71b/elementary_math-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "9f6e46d92f6045eac239f7854709f34b", "sha256": "06756e0c93650f94c42af8cc2ad65c6290d1cb680960d18643c7b4b89d73dfd9" }, "downloads": -1, "filename": "elementary_math-0.0.5-py2-none-any.whl", "has_sig": false, "md5_digest": "9f6e46d92f6045eac239f7854709f34b", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 9399, "upload_time": "2017-08-31T19:07:52", "url": "https://files.pythonhosted.org/packages/52/3e/b1f157049c0065d55de61c78d5e2a2fc6a79a5767924c019b5a311118813/elementary_math-0.0.5-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "61ce01d9f2db1bb3984c2175c5e8f9d3", "sha256": "dd822f517409baa29965211329d2e3723515ff90bff4bcdad3713b1a7772ea00" }, "downloads": -1, "filename": "elementary_math-0.0.5.tar.gz", "has_sig": false, "md5_digest": "61ce01d9f2db1bb3984c2175c5e8f9d3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5789, "upload_time": "2017-08-31T19:07:54", "url": "https://files.pythonhosted.org/packages/b1/68/7ca13b671e8f2fa7b31e4c775bc6c11fe01ed2e7591faf8516ca3bba4a31/elementary_math-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "b2baae1e45473b7b30d67216beb84b47", "sha256": "42c75b9115cb649345b2b3a120df2f604ae54d83a0784e83040ace4ed86ad51a" }, "downloads": -1, "filename": "elementary_math-0.0.6-py2-none-any.whl", "has_sig": false, "md5_digest": "b2baae1e45473b7b30d67216beb84b47", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 9565, "upload_time": "2017-08-31T19:25:02", "url": "https://files.pythonhosted.org/packages/90/b1/37346f4c6d1861206c983f2ba17fd00d8dbaa6b0328848da3649dad760d4/elementary_math-0.0.6-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "da33895f480103d9b6284dbbb070a121", "sha256": "bc3cd0ea94765f90ed9dd4e2b6462ac3931a1f37e5f959b16c7f890af73acbe2" }, "downloads": -1, "filename": "elementary_math-0.0.6.tar.gz", "has_sig": false, "md5_digest": "da33895f480103d9b6284dbbb070a121", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5908, "upload_time": "2017-08-31T19:25:04", "url": "https://files.pythonhosted.org/packages/c5/0c/e629baed69c315c708b3932f7a5afabe6576f50e4f3afb8490a6e955ac04/elementary_math-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "cb070ec78cd7e010b0f4773c81a98779", "sha256": "9baa19dda4fdb13c03e78521f75072b21fb70770e3c4291475f7ec261e68ef01" }, "downloads": -1, "filename": "elementary_math-0.0.7-py2-none-any.whl", "has_sig": false, "md5_digest": "cb070ec78cd7e010b0f4773c81a98779", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 10483, "upload_time": "2017-09-01T00:01:46", "url": "https://files.pythonhosted.org/packages/a9/55/60ec997058432ea24b67eedf9f28e56bccb4291dc9a98d921da7dc7e2a1d/elementary_math-0.0.7-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "860a6a4e21fbe8a6c1bce52bb73bc732", "sha256": "891f589683de221aea7ee844ba4bbeda6dead407f9290f70249dc51a9fed5907" }, "downloads": -1, "filename": "elementary_math-0.0.7.tar.gz", "has_sig": false, "md5_digest": "860a6a4e21fbe8a6c1bce52bb73bc732", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6473, "upload_time": "2017-09-01T00:01:47", "url": "https://files.pythonhosted.org/packages/b3/93/af279539c9f4a919a4cc4844d0d31e0cb63d197f08957043d7b39e840bee/elementary_math-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "0cb12165c2bfb37c84ac316bcef19e21", "sha256": "12f13800d1663347fbd1c37851e070d899e21d4b54f1c6aba8b1942acb59163f" }, "downloads": -1, "filename": "elementary_math-0.0.8-py2-none-any.whl", "has_sig": false, "md5_digest": "0cb12165c2bfb37c84ac316bcef19e21", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 12559, "upload_time": "2017-09-07T07:44:09", "url": "https://files.pythonhosted.org/packages/00/57/53ab52701723b78d47bdc47c7ea8d877e85723a7d9bcb57e4cc4d134cd9d/elementary_math-0.0.8-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7a8b8acbcd3628acc2ebe352581797b2", "sha256": "14b210128d8f19d3ea4795624a20ccd234ce3116ff24713df4d0ab1c06c7cf1a" }, "downloads": -1, "filename": "elementary_math-0.0.8.tar.gz", "has_sig": false, "md5_digest": "7a8b8acbcd3628acc2ebe352581797b2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7987, "upload_time": "2017-09-07T07:44:11", "url": "https://files.pythonhosted.org/packages/d5/49/ec52a5ce3b606180a27590937cad83892197e75b05d9347de7c771a79489/elementary_math-0.0.8.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0cb12165c2bfb37c84ac316bcef19e21", "sha256": "12f13800d1663347fbd1c37851e070d899e21d4b54f1c6aba8b1942acb59163f" }, "downloads": -1, "filename": "elementary_math-0.0.8-py2-none-any.whl", "has_sig": false, "md5_digest": "0cb12165c2bfb37c84ac316bcef19e21", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 12559, "upload_time": "2017-09-07T07:44:09", "url": "https://files.pythonhosted.org/packages/00/57/53ab52701723b78d47bdc47c7ea8d877e85723a7d9bcb57e4cc4d134cd9d/elementary_math-0.0.8-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7a8b8acbcd3628acc2ebe352581797b2", "sha256": "14b210128d8f19d3ea4795624a20ccd234ce3116ff24713df4d0ab1c06c7cf1a" }, "downloads": -1, "filename": "elementary_math-0.0.8.tar.gz", "has_sig": false, "md5_digest": "7a8b8acbcd3628acc2ebe352581797b2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7987, "upload_time": "2017-09-07T07:44:11", "url": "https://files.pythonhosted.org/packages/d5/49/ec52a5ce3b606180a27590937cad83892197e75b05d9347de7c771a79489/elementary_math-0.0.8.tar.gz" } ] }