Author: Deepjyoti Mondal

The Loklak applications site now has a functional store listing page where developers can showcase their apps and users and other developers can get all sorts of information about an app. However, for an app to be showcased properly on store listing page, the app must contain a properly configured app.json file and some necessary assets. But while creating an app a developer might miss out some vital information from app.json or forget to provide some of the required assets, which he will later come to know from his co-developers or reviewers. Now this will cause inconvenience, both for the developer and reviewer. So to overcome this apps.loklak.org has now got a new script to review a given app. It checks whether the necessary fields are present in app.json or not. If present then it checks whether the fields are empty or not. If any invalid or missing information problem is encountered then it is reported to the developer along with information on what should be the actual case. If the app passes all the checks then the developer is informed that his app is ready to be published. In order to use this script all the developer needs to do is open his app directory in terminal and execute the following command ../bin/review.sh This will present the developer with all the necessary informations. How the script works? Now let us delve into the working of the script. The initial call to the shell script review.sh calls a python script review.py. This python script performs all the checks on the app and displays necessary informations. The first thing the script does is, it checks whether there is an app.json present in the app directory or not, if yes then the process continues otherwise it ends immediately with an error. if "app.json" not in dir_contents: print_info("Please include a well configured app.json") print_problem("review failed") exit(0) Next it performs one of the most important checks. It verifies whether the name of the app and app directory name is same or not. If it is same then there is no problem else it shows the corresponding error message. app_dir_name = os.getcwd().split("/")[-1] if app_dir_name != app_json.get("name"): print_problem("app directory name and name mentioned in app.json are different") print_info("app directory name and name mentioned in app.json must be same") problems_no += 1 Next the script checks whether there is an index.html present or not. Index.html is a must as it serves as the entry point of the app. if "index.html" not in dir_contents: print_problem("index.html is missing") print_info("app must contain index.html") problems_no += 1 After this the script checks whether a number of key fields are present or not. These field includes applicationCategory, oneLineDescription, author. If they are present, it checks whether the fields are empty or not. If the fields are either absent or empty, error is shown to the developer. if app_json.get("applicationCategory") == None: print_problem("key applicationCategory missing in app.json") print_info("app.json must contain key applicationCategory with category as value") problems_no += 1 else: if app_json.get("applicationCategory") == "":…

There are various apps presently hosted on apps.loklak.org, which shows several interesting and awesome stuff that can be done using the loklak API. Now the question is how to create a loklak app? Well previously there were two ways to create a loklak app, you could either create an app from scratch creating all the necessary files including index.html (app entry point), app.json (required for maintaining app metadata and store listing), getStarted.md, appUse.md and other necessary files, or you could use the boilerplate app which provides you with a ready to go app template which you have to edit to create your app. Recently there has been a new addition to the repository, a command line tool called loklakinit, built with python which will automate the process of initiating a loklak app on the go. The tool creates the entire loklak app directory structure including app.json with all the necessary details (as provided by the user) and defaults, index.html, a css and js subdirectory with a style.css and script.js in the respective folders, getStarted.md file, appUse.md file and others.md file with proper references in app.json. All that the developer needs to do is, execute the following from the root of the apps.loklak.org repository. bin/loklakinit.sh This will start the process and initiate the app. Creating loklakinit tool Now let us delve into the code. So what actually the script does? How it works? Well the tool acts very much like the popular npm init command. At first the script creates a dictionary which stores the defaults for app.json. Next the script takes a number of inputs from the user and predicts some default values, if the user refuses to provide any input for a particular parameter then the default value for that parameter is used. app_json = collections.OrderedDict() app_json["@context"] = "http://schema.org" app_json["@type"] = "SoftwareApplication" app_json["permissions"] = "/api/search.json" app_json["name"] = "myloklakapp" app_json["headline"] = "My first loklak app" app_json["alternativeHeadline"] = app_json["headline"] app_json["applicationCategory"] = "Misc" app_json["applicationSubCategory"] = "" app_json["operatingSystem"] = "http://loklak.org" app_json["promoImage"] = "promo.png" app_json["appImages"] = "" app_json["oneLineDescription"] = "" app_json["getStarted"] = "getStarted.md" app_json["appUse"] = "appUse.md" app_json["others"] = "others.md" author = collections.OrderedDict() author["@type"] = "Person" author["name"] = "" author["email"] = "" author["url"] = "" author["sameAs"] = "" app_json["author"] = author The first part of the script inserts some default values into the app_json dictionary. Now what is an OrderedDict? Well, it is nothing but a python dictionary in which the order in which the keys are inserted is maintained. A ordinary python dictionary does not maintain the order of the keys. while True : app_name = raw_input("name (" + app_json["name"] + ") : ") if app_name : app_json["name"] = app_name app_context = raw_input("@context (" + app_json["@context"] + ") : ") if app_context : app_json["@context"] = app_context app_type = raw_input("@type (" + app_json["@type"] + ") : ") if app_type : app_json["@type"] = app_type app_permissions = raw_input("permissions (" + app_json["permissions"] + ") : ") if app_permissions : app_json["permissions"] = app_permissions.split(",") app_headline = raw_input("headline (" + app_json["headline"] + ") : ") if app_headline : app_json["headline"] = app_headline…

The Github profile scraper is one of the several scrapers present in the loklak project, some of the other scrapers being Quora profile scraper, Wordpress profile scraper, Instagram profile scraper, etc.Github profile scraper scrapes the profile of a given github user and provides the data in json format. The scraped data contains user_id, followers, users following the given user, starred repositories of an user, basic information like user’s name, bio and much more. It uses the popular Java Jsoup library for scraping. The entire source code for the scraper can be found here. Changes made The scraper previously provided very limited information like, name of the user, description, starred repository url, followers url, following url, user_id, etc. One of the major problem was the api accepted only the profile name as a parameter and it returned the entire data, that is, the scraper scraped all the data even if the user did not ask for it. Moreover the service provided certain urls as data for example starred repository url, followers url, following url instead of providing the actual data present at those urls. The scraper contained only one big function where all the scraping was performed. The code was not modular. The scraper has been enhanced in the ways mentioned below. The entire code has been refactored.Code scraping user specific data has been separated from code scraping organization specific data. Also separate method has been created for accessing the Github API. Apart from profile parameter, the api now accepts another parameter called terms. It is a list of fields the user wants information on. In this way the scraper scrapes only that much data which is required by the user. This allows better response time and prevents unnecessary scraping. The scraper now provides more information like user gists, subscriptions, events, received_events and repositories. Code refactoring The code has been refactored to smaller methods. ‘getDataFromApi’ method has been designed to access Github API. All the other methods which want to make request to api.github.com/ now calls ‘getDatFromApi’ method with required parameter. The method is shown below. private static JSONArray getDataFromApi(String url) { URI uri = null; try { uri = new URI(url); } catch (URISyntaxException e1) { e1.printStackTrace(); } JSONTokener tokener = null; try { tokener = new JSONTokener(uri.toURL().openStream()); } catch (Exception e1) { e1.printStackTrace(); } JSONArray arr = new JSONArray(tokener); return arr; }   For example if we want to make a request to the endpoint https://api.github.com/users/djmgit/followers then we can use the above method and we will get a JSONArray in return. All the code which scrapes user related data has been moved to ‘scrapeGithubUser’ method. This method scrapes basic user information like full name of the user, bio, user name, atom feed link, and location. String fullName = html.getElementsByAttributeValueContaining("class", "vcard-fullname").text(); githubProfile.put("full_name", fullName); String userName = html.getElementsByAttributeValueContaining("class", "vcard-username").text(); githubProfile.put("user_name", userName); String bio = html.getElementsByAttributeValueContaining("class", "user-profile-bio").text(); githubProfile.put("bio", bio); String atomFeedLink = html.getElementsByAttributeValueContaining("type", "application/atom+xml").attr("href"); githubProfile.put("atom_feed_link", "https://github.com" + atomFeedLink); String worksFor = html.getElementsByAttributeValueContaining("itemprop", "worksFor").text(); githubProfile.put("works_for", worksFor); String homeLocation = html.getElementsByAttributeValueContaining("itemprop", "homeLocation").attr("title"); githubProfile.put("home_location", homeLocation);…