github.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Requesting Data Using an API Call and Plotly\n",
    "\n",
    "[Check limit of requests](https://api.github.com/rate_limit)\n",
    "\n",
    "### Processing an API Response"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Status code: 200\n",
      "dict_keys(['total_count', 'incomplete_results', 'items'])\n"
     ]
    }
   ],
   "source": [
    "# Import modules\n",
    "import requests\n",
    "from plotly.graph_objs import Bar\n",
    "from plotly import offline\n",
    "\n",
    "# Make and API call and store the response\n",
    "url = 'https://api.github.com/search/repositories?q=language:python&sort=stars'\n",
    "\n",
    "# Define headers\n",
    "headers = {'Accept': 'application/vnd.github.v3+json'}\n",
    "\n",
    "# Make requests\n",
    "r = requests.get(url, headers=headers)\n",
    "\n",
    "# Print the value of status_code\n",
    "print(f\"Status code: {r.status_code}\")\n",
    "\n",
    "# Store API response in a variable\n",
    "response_dict = r.json()\n",
    "\n",
    "# Processs results\n",
    "print(response_dict.keys())"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Working with the Response Dictionary"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Total repositories: 8603097\n"
     ]
    }
   ],
   "source": [
    "# Print the total number of Python repositories\n",
    "print(f\"Total repositories: {response_dict['total_count']}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Repositories returned: 30\n",
      "\n",
      "Keys: 78\n",
      "allow_forking\n",
      "archive_url\n",
      "archived\n",
      "assignees_url\n",
      "blobs_url\n",
      "branches_url\n",
      "clone_url\n",
      "collaborators_url\n",
      "comments_url\n",
      "commits_url\n",
      "compare_url\n",
      "contents_url\n",
      "contributors_url\n",
      "created_at\n",
      "default_branch\n",
      "deployments_url\n",
      "description\n",
      "disabled\n",
      "downloads_url\n",
      "events_url\n",
      "fork\n",
      "forks\n",
      "forks_count\n",
      "forks_url\n",
      "full_name\n",
      "git_commits_url\n",
      "git_refs_url\n",
      "git_tags_url\n",
      "git_url\n",
      "has_downloads\n",
      "has_issues\n",
      "has_pages\n",
      "has_projects\n",
      "has_wiki\n",
      "homepage\n",
      "hooks_url\n",
      "html_url\n",
      "id\n",
      "is_template\n",
      "issue_comment_url\n",
      "issue_events_url\n",
      "issues_url\n",
      "keys_url\n",
      "labels_url\n",
      "language\n",
      "languages_url\n",
      "license\n",
      "merges_url\n",
      "milestones_url\n",
      "mirror_url\n",
      "name\n",
      "node_id\n",
      "notifications_url\n",
      "open_issues\n",
      "open_issues_count\n",
      "owner\n",
      "private\n",
      "pulls_url\n",
      "pushed_at\n",
      "releases_url\n",
      "score\n",
      "size\n",
      "ssh_url\n",
      "stargazers_count\n",
      "stargazers_url\n",
      "statuses_url\n",
      "subscribers_url\n",
      "subscription_url\n",
      "svn_url\n",
      "tags_url\n",
      "teams_url\n",
      "topics\n",
      "trees_url\n",
      "updated_at\n",
      "url\n",
      "visibility\n",
      "watchers\n",
      "watchers_count\n"
     ]
    }
   ],
   "source": [
    "# Explore information about the repositories.\n",
    "repo_dicts = response_dict['items']\n",
    "print(f\"Repositories returned: {len(repo_dicts)}\")\n",
    "\n",
    "# Examine the first repository\n",
    "repo_dict = repo_dicts[0]\n",
    "\n",
    " # Print the length of repo_dicts -how many repositories?\n",
    "print(f\"\\nKeys: {len(repo_dict)}\")\n",
    "\n",
    "# print all keys\n",
    "for key in sorted(repo_dict.keys()): \n",
    "    print(key)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "Selected information about first repository:\n",
      "Name: Python\n",
      "Owner: geekcomputers\n",
      "Stars: 24884\n",
      "Repository: https://github.com/geekcomputers/Python\n",
      "Created: 2011-11-30T09:04:08Z\n",
      "Updated: 2022-03-18T16:23:47Z\n",
      "Description: My Python Examples\n"
     ]
    }
   ],
   "source": [
    "print(\"\\nSelected information about first repository:\") # Title\n",
    "print(f\"Name: {repo_dict['name']}\") # Name of the project\n",
    "print(f\"Owner: {repo_dict['owner']['login']}\") # Access the dictionary representing the owner\n",
    "print(f\"Stars: {repo_dict['stargazers_count']}\") # Print how many stars the project has earned\n",
    "print(f\"Repository: {repo_dict['html_url']}\") # Url\n",
    "print(f\"Created: {repo_dict['created_at']}\") # Date of birth\n",
    "print(f\"Updated: {repo_dict['updated_at']}\") # Last update\n",
    "print(f\"Description: {repo_dict['description']}\") # Description"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Summarizing the Top Repositories"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "Selected information about each repository:\n",
      "\n",
      "Name: system-design-primer\n",
      "Owner: donnemartin\n",
      "Stars: 167156\n",
      "Repository: https://github.com/donnemartin/system-design-primer\n",
      "Description: Learn how to design large-scale systems. Prep for the system design interview.  Includes Anki flashcards.\n",
      "\n",
      "Name: Python\n",
      "Owner: TheAlgorithms\n",
      "Stars: 132380\n",
      "Repository: https://github.com/TheAlgorithms/Python\n",
      "Description: All Algorithms implemented in Python\n",
      "\n",
      "Name: youtube-dl\n",
      "Owner: ytdl-org\n",
      "Stars: 107704\n",
      "Repository: https://github.com/ytdl-org/youtube-dl\n",
      "Description: Command-line program to download videos from YouTube.com and other video sites\n",
      "\n",
      "Name: thefuck\n",
      "Owner: nvbn\n",
      "Stars: 67298\n",
      "Repository: https://github.com/nvbn/thefuck\n",
      "Description: Magnificent app which corrects your previous console command.\n",
      "\n",
      "Name: django\n",
      "Owner: django\n",
      "Stars: 62949\n",
      "Repository: https://github.com/django/django\n",
      "Description: The Web framework for perfectionists with deadlines.\n",
      "\n",
      "Name: transformers\n",
      "Owner: huggingface\n",
      "Stars: 59564\n",
      "Repository: https://github.com/huggingface/transformers\n",
      "Description: 🤗 Transformers: State-of-the-art Machine Learning for Pytorch, TensorFlow, and JAX.\n",
      "\n",
      "Name: keras\n",
      "Owner: keras-team\n",
      "Stars: 54666\n",
      "Repository: https://github.com/keras-team/keras\n",
      "Description: Deep Learning for humans\n",
      "\n",
      "Name: HelloGitHub\n",
      "Owner: 521xueweihan\n",
      "Stars: 53199\n",
      "Repository: https://github.com/521xueweihan/HelloGitHub\n",
      "Description: :octocat: 分享 GitHub 上有趣、入门级的开源项目。Share interesting, entry-level open source projects on GitHub.\n",
      "\n",
      "Name: ansible\n",
      "Owner: ansible\n",
      "Stars: 52475\n",
      "Repository: https://github.com/ansible/ansible\n",
      "Description: Ansible is a radically simple IT automation platform that makes your applications and systems easier to deploy and maintain. Automate everything from code deployment to network configuration to cloud management, in a language that approaches plain English, using SSH, with no agents to install on remote systems. https://docs.ansible.com.\n",
      "\n",
      "Name: scikit-learn\n",
      "Owner: scikit-learn\n",
      "Stars: 49379\n",
      "Repository: https://github.com/scikit-learn/scikit-learn\n",
      "Description: scikit-learn: machine learning in Python\n",
      "\n",
      "Name: requests\n",
      "Owner: psf\n",
      "Stars: 47075\n",
      "Repository: https://github.com/psf/requests\n",
      "Description: A simple, yet elegant, HTTP library.\n",
      "\n",
      "Name: cpython\n",
      "Owner: python\n",
      "Stars: 43406\n",
      "Repository: https://github.com/python/cpython\n",
      "Description: The Python programming language\n",
      "\n",
      "Name: manim\n",
      "Owner: 3b1b\n",
      "Stars: 43199\n",
      "Repository: https://github.com/3b1b/manim\n",
      "Description: Animation engine for explanatory math videos\n",
      "\n",
      "Name: big-list-of-naughty-strings\n",
      "Owner: minimaxir\n",
      "Stars: 42061\n",
      "Repository: https://github.com/minimaxir/big-list-of-naughty-strings\n",
      "Description: The Big List of Naughty Strings is a list of strings which have a high probability of causing issues when used as user-input data.\n",
      "\n",
      "Name: faceswap\n",
      "Owner: deepfakes\n",
      "Stars: 40553\n",
      "Repository: https://github.com/deepfakes/faceswap\n",
      "Description: Deepfakes Software For All\n",
      "\n",
      "Name: rich\n",
      "Owner: Textualize\n",
      "Stars: 35927\n",
      "Repository: https://github.com/Textualize/rich\n",
      "Description: Rich is a Python library for rich text and beautiful formatting in the terminal.\n",
      "\n",
      "Name: CppCoreGuidelines\n",
      "Owner: isocpp\n",
      "Stars: 33476\n",
      "Repository: https://github.com/isocpp/CppCoreGuidelines\n",
      "Description: The C++ Core Guidelines are a set of tried-and-true guidelines, rules, and best practices about coding in C++\n",
      "\n",
      "Name: pandas\n",
      "Owner: pandas-dev\n",
      "Stars: 33070\n",
      "Repository: https://github.com/pandas-dev/pandas\n",
      "Description: Flexible and powerful data analysis / manipulation library for Python, providing labeled data structures similar to R data.frame objects, statistical functions, and much more\n",
      "\n",
      "Name: python-patterns\n",
      "Owner: faif\n",
      "Stars: 30953\n",
      "Repository: https://github.com/faif/python-patterns\n",
      "Description: A collection of design patterns/idioms in Python\n",
      "\n",
      "Name: d2l-zh\n",
      "Owner: d2l-ai\n",
      "Stars: 30763\n",
      "Repository: https://github.com/d2l-ai/d2l-zh\n",
      "Description: 《动手学深度学习》：面向中文读者、能运行、可讨论。中英文版被55个国家的300所大学用于教学。\n",
      "\n",
      "Name: bert\n",
      "Owner: google-research\n",
      "Stars: 30685\n",
      "Repository: https://github.com/google-research/bert\n",
      "Description: TensorFlow code and pre-trained models for BERT\n",
      "\n",
      "Name: sentry\n",
      "Owner: getsentry\n",
      "Stars: 30360\n",
      "Repository: https://github.com/getsentry/sentry\n",
      "Description: Sentry is cross-platform application monitoring, with a focus on error reporting.\n",
      "\n",
      "Name: sherlock\n",
      "Owner: sherlock-project\n",
      "Stars: 30019\n",
      "Repository: https://github.com/sherlock-project/sherlock\n",
      "Description: 🔎 Hunt down social media accounts by username across social networks\n",
      "\n",
      "Name: wtfpython\n",
      "Owner: satwikkansal\n",
      "Stars: 28416\n",
      "Repository: https://github.com/satwikkansal/wtfpython\n",
      "Description: What the f*ck Python? 😱\n",
      "\n",
      "Name: python-cheatsheet\n",
      "Owner: gto76\n",
      "Stars: 28331\n",
      "Repository: https://github.com/gto76/python-cheatsheet\n",
      "Description: Comprehensive Python Cheatsheet\n",
      "\n",
      "Name: gym\n",
      "Owner: openai\n",
      "Stars: 26946\n",
      "Repository: https://github.com/openai/gym\n",
      "Description: A toolkit for developing and comparing reinforcement learning algorithms.\n",
      "\n",
      "Name: black\n",
      "Owner: psf\n",
      "Stars: 26383\n",
      "Repository: https://github.com/psf/black\n",
      "Description: The uncompromising Python code formatter\n",
      "\n",
      "Name: airflow\n",
      "Owner: apache\n",
      "Stars: 25176\n",
      "Repository: https://github.com/apache/airflow\n",
      "Description: Apache Airflow - A platform to programmatically author, schedule, and monitor workflows\n",
      "\n",
      "Name: Detectron\n",
      "Owner: facebookresearch\n",
      "Stars: 25030\n",
      "Repository: https://github.com/facebookresearch/Detectron\n",
      "Description: FAIR's research platform for object detection research, implementing popular algorithms like Mask R-CNN and RetinaNet.\n",
      "\n",
      "Name: Python\n",
      "Owner: geekcomputers\n",
      "Stars: 24884\n",
      "Repository: https://github.com/geekcomputers/Python\n",
      "Description: My Python Examples\n"
     ]
    }
   ],
   "source": [
    "print(\"\\nSelected information about each repository:\")\n",
    "for repo_dict in repo_dicts:\n",
    "    print(f\"\\nName: {repo_dict['name']}\")\n",
    "    print(f\"Owner: {repo_dict['owner']['login']}\")\n",
    "    print(f\"Stars: {repo_dict['stargazers_count']}\")\n",
    "    print(f\"Repository: {repo_dict['html_url']}\")\n",
    "    print(f\"Description: {repo_dict['description']}\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Visualizing Repositories with Plotly"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 40,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'python_repos.html'"
      ]
     },
     "execution_count": 40,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Process results (refresh)\n",
    "# response_dict = r.json()\n",
    "# repo_dicts = response_dict['items']\n",
    "\n",
    "# Create two empty lists\n",
    "repo_links, stars, labels = [], [], []\n",
    "\n",
    "for repo_dict in repo_dicts:\n",
    "    repo_name = repo_dict['name']\n",
    "    repo_url = repo_dict['html_url']\n",
    "    repo_link = f\"<a href='{repo_url}'>{repo_name}</a>\"\n",
    "    repo_links.append(repo_link)\n",
    "    stars.append(repo_dict[\"stargazers_count\"])\n",
    "\n",
    "# Generate a string for the label with a line break\n",
    "owner = repo_dict['owner']['login']\n",
    "description = repo_dict['description']\n",
    "label = f\"{owner}<br />{description}\"\n",
    "labels.append(label)\n",
    "\n",
    "# Plot bar graph\n",
    "data = [{\n",
    "    'type': 'bar',\n",
    "    'x': repo_links,\n",
    "    'y': stars,\n",
    "    'hovertext': labels,\n",
    "    'marker': {\n",
    "        'color': '#f72585',\n",
    "        'line': {'width': 1.5, 'color': '#7209b7'}\n",
    "    },\n",
    "    'opacity': 0.6,\n",
    "}]\n",
    "\n",
    "my_layout = {\n",
    "    'title': 'Most-Starred Python Projects on GitHub',\n",
    "    'titlefont': {'size': 28},\n",
    "    'xaxis': {\n",
    "        'title': 'Repository',\n",
    "        'titlefont': {'size': 24},\n",
    "        'tickfont': {'size': 14},\n",
    "    },\n",
    "    'yaxis': {\n",
    "        'title': 'Stars',\n",
    "        'titlefont': {'size': 24},\n",
    "        'tickfont': {'size': 14},\n",
    "    },\n",
    "}\n",
    "\n",
    "fig = {'data': data, 'layout': my_layout}\n",
    "offline.plot(fig, filename='python_repos.html')"
   ]
  }
 ],
 "metadata": {
  "interpreter": {
   "hash": "3e49c3c660bb3da03bb80538bab8d3b7446076cf250c2919d2328cdd966089b9"
  },
  "kernelspec": {
   "display_name": "Python 3.9.7 ('env_full')",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.7"
  },
  "orig_nbformat": 4
 },
 "nbformat": 4,
 "nbformat_minor": 2
}