{ "info": { "author": "Shrikrishna Singh", "author_email": "krishnasingh.ss30@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Django :: 1.11", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": "=============================\nopenhub-django\n=============================\n\n.. image:: https://badge.fury.io/py/openhub-django.svg\n :target: https://badge.fury.io/py/openhub-django\n\n.. image:: https://travis-ci.org/sks444/openhub-django.svg?branch=master\n :target: https://travis-ci.org/sks444/openhub-django\n\n.. image:: https://codecov.io/gh/sks444/openhub-django/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/sks444/openhub-django\n\nIntegrate openhub APIs with Django\n\nDocumentation\n-------------\n\nThe full documentation is at https://openhub-django.readthedocs.io.\n\nQuickstart\n----------\n\nI. **Install openhub-django:**\n\n.. code-block:: bash\n\n pip install openhub-django\n\n\nII. Add it to your :code:`INSTALLED_APPS`:\n\n.. code-block:: python\n\n INSTALLED_APPS = (\n ...\n 'openhub_django.apps.OpenhubDjangoConfig',\n ...\n )\n\n\nIII. **Add openhub-django's URL patterns:**\n\n.. code-block:: python\n\n\n urlpatterns = [\n ...\n url(r'^', include('openhub_django.urls')),\n ...\n ]\n\nIV. **Configure following environment variables:**\n\n * **OpenHub Token**\n\n How to get OpenHub Token?\n\n 1. Signup with GitHub on OpenHub_\n 2. Go to your profile settings to create a new API Key.\n 3. Choose \"API Keys\" from the section and create a new one by clicking on button \"Request New API Key\"\n 4. Fill in the required fields and Save it.\n 5. Copy the :code:`API Key` for the generated token to add it to your environment.\n\n Add it to your Linux (or Ubuntu) environment-\n\n 1. Open the terminal and run `cat ~/.bashrc`.\n 2. Find this peice of code\n\n .. code-block:: bash\n\n if [ -f ~/.bash_aliases ]; then\n . ~/.bash_aliases\n fi\n\n 3. In this case we will create a new file in :code:`$HOME` directory named\n :code:`.bash_aliases` to store our environment variables. As it will execute\n everytime we open a new terminal window.\n\n .. code-block:: bash\n\n vi ~/.bash_aliases\n\n 4. Enter into the insert mode and add the value of token that you generated from OpenHub settings.\n\n .. code-block:: bash\n\n export OH_TOKEN=\n\n 5. Exit the insert mode by pressing :code:`esc` key and the editor.\n 6. Restart your terminal and run :code:`printenv` to verify the API Key added.\n\n\n * **Organization name**\n\n Set the environment variable :code:`ORG_NAME` following the above mentioned steps like you\n did adding the environment variable :code:`OH_TOKEN`. Once you setup these two environment\n variables, you're ready to run a management command to fetch the organization related\n information from OpenHub.\n\nV. **Run management command**\n\n.. code-block:: bash\n\n python manage.py migrate\n\n python manage.py import_openhub_data\n\nVI. **View the fetched data:**\n\n.. code-block:: bash\n\n python manage.py runserver\n\n # Open http://127.0.0.1:8000/openhub/ in browser\n\nFeatures\n--------\n\n* Import all the organization *portfolio projects* data\n* Import all the organization *outside projects* data such as dependencies\n* Import all the *affiliated committers* data who made contributions to the projects\n* Import all the *outside committers* data\n* Import the *organization* related information\n* Generate the static web-pages of all the imported data with an interactive UI/UX design.\n\n\nRunning Tests\n-------------\n\nDoes the code actually work?\n\n::\n\n source /bin/activate\n (myenv) $ pip install tox\n (myenv) $ tox\n\nCredits\n-------\n\nTools used in rendering this package:\n\n* Cookiecutter_\n* `cookiecutter-djangopackage`_\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage\n.. _OpenHub: https://www.openhub.net/accounts/new\n\n\n\n\nHistory\n-------\n\n0.1.0 (2018-08-14)\n++++++++++++++++++\n\n* First release on PyPI.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/sks444/openhub-django", "keywords": "openhub-django", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "openhub-django", "package_url": "https://pypi.org/project/openhub-django/", "platform": "", "project_url": "https://pypi.org/project/openhub-django/", "project_urls": { "Homepage": "https://github.com/sks444/openhub-django" }, "release_url": "https://pypi.org/project/openhub-django/0.1.0/", "requires_dist": [ "django-model-utils (>=2.0)", "xmltodict", "python-decouple", "django-distill" ], "requires_python": "", "summary": "Integrate openhub APIs with Django", "version": "0.1.0" }, "last_serial": 5618152, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "5e9ef4451b7a2293bbf11b2d423ec8b6", "sha256": "771d3ec318f16daddbebda8c9923ff29e41b213bdf7fb5734b33e2eb760d8d73" }, "downloads": -1, "filename": "openhub_django-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5e9ef4451b7a2293bbf11b2d423ec8b6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 25692, "upload_time": "2019-08-01T11:05:18", "url": "https://files.pythonhosted.org/packages/46/da/22e015528d506a3dcaffd29cd68db9b20e7c30919558b9eb57b033d75a78/openhub_django-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fe5af041f6354ea0195a1e0283c4c4ff", "sha256": "22ac0e91ac01878a0d10cd01aedc04db4d76c682698fffe7073fec2faecf5dc5" }, "downloads": -1, "filename": "openhub-django-0.1.0.tar.gz", "has_sig": false, "md5_digest": "fe5af041f6354ea0195a1e0283c4c4ff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16795, "upload_time": "2019-08-01T11:05:21", "url": "https://files.pythonhosted.org/packages/a3/16/b72b49f0cad5a3e1e5befee732e511138a894f89af1adbbe3de933a85fd8/openhub-django-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5e9ef4451b7a2293bbf11b2d423ec8b6", "sha256": "771d3ec318f16daddbebda8c9923ff29e41b213bdf7fb5734b33e2eb760d8d73" }, "downloads": -1, "filename": "openhub_django-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5e9ef4451b7a2293bbf11b2d423ec8b6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 25692, "upload_time": "2019-08-01T11:05:18", "url": "https://files.pythonhosted.org/packages/46/da/22e015528d506a3dcaffd29cd68db9b20e7c30919558b9eb57b033d75a78/openhub_django-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fe5af041f6354ea0195a1e0283c4c4ff", "sha256": "22ac0e91ac01878a0d10cd01aedc04db4d76c682698fffe7073fec2faecf5dc5" }, "downloads": -1, "filename": "openhub-django-0.1.0.tar.gz", "has_sig": false, "md5_digest": "fe5af041f6354ea0195a1e0283c4c4ff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16795, "upload_time": "2019-08-01T11:05:21", "url": "https://files.pythonhosted.org/packages/a3/16/b72b49f0cad5a3e1e5befee732e511138a894f89af1adbbe3de933a85fd8/openhub-django-0.1.0.tar.gz" } ] }