{"id":23409368,"url":"https://github.com/riverma/bosha","last_synced_at":"2025-04-09T01:47:13.741Z","repository":{"id":72908668,"uuid":"166735995","full_name":"riverma/bosha","owner":"riverma","description":"BOSHA: Business OwnerSHip Analyser","archived":false,"fork":false,"pushed_at":"2019-01-21T02:35:49.000Z","size":21649,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-14T20:37:06.434Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/riverma.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-01-21T02:29:04.000Z","updated_at":"2019-01-21T02:35:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"f9d4110c-1982-4553-bc2b-a0abf523e7f2","html_url":"https://github.com/riverma/bosha","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riverma%2Fbosha","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riverma%2Fbosha/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riverma%2Fbosha/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riverma%2Fbosha/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/riverma","download_url":"https://codeload.github.com/riverma/bosha/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247958716,"owners_count":21024828,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-22T15:35:35.886Z","updated_at":"2025-04-09T01:47:13.710Z","avatar_url":"https://github.com/riverma.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BOSHA: Business OwnerSHip Analyser\n\n\u003cem\u003eCreates an database \u0026 dashboard for analysing business ownership in your city\u003c/em\u003e\n\n## Introduction\n\nThis codebase builds an Elasticsearch database and visualization dashboard\npopulated with business ownership information derived from Reference USA.\n\n## Requirements\n\nThe following third-party tools / platforms are a requirement to run BOSHA:\n- Unix-based operating system (e.g. Linux, MacOSX, etc.)\n- cURL: https://curl.haxx.se/\n- jq: https://stedolan.github.io/jq/\n- csvkit: https://csvkit.readthedocs.io/en/1.0.3/\n- Ruby: https://www.ruby-lang.org/en/downloads/\n- pup: https://github.com/EricChiang/pup\n- parallel (GNU Parallels): https://www.gnu.org/software/parallel/\n- docker: https://www.docker.com/products/docker-desktop\n\n## Configuration\n\nThe following steps will need to be performed before executing any code in this\nrepository.\n\n1. Obtain access to [Reference USA](www.referenceusa.com) and have in mind a\ncity or geographic area you'd like to collect business ownership information\nabout.\n2. Create a directory where you will store CSV record data for all businesses\nwithin your chosen geographic area.\n3. Navigate to [Reference USA](www.referenceusa.com), and download CSV files\nrepresenting ALL metadata fields for all businesses within your chosen\ngeographic area. Download these CSV files to your chosen directory from step 2.\nFollow tutorials at Reference USA's website for how to export CSV data.\n  - Note: you may be limited to up to 250 record downloads per search. Thus it\n  could take a long time to download all CSV records for all businesses in a\n  large city.\n4. Choose a name without punctuation or spaces, for the database where your\nbusiness record data will be stored. Typically this would be your city name.\n  - open line 22 of ``kibana-dashboard.json`` and change ``pasadena`` to the\n  name of the database you'd like to use.\n5. Decrypt ``biz_id_num_to_details.sh`` and modify the script as detailed in the\n``refusa_howto_mov`` movie (which also needs to be decrypted). Consult Rishi for\nspecifics.\n\n## Running\n\n\u003cem\u003eONLY AFTER THE ABOVE CONFIGURATION STEPS ARE COMPLETE\u003c/em\u003e\n\nFollow the below steps to load the database with relevant business details.\n1. Run the ``steps.sh`` script to load\nbusiness data, that is correlated with geo-point location data, into a custom\nElasticsearch datastore. This script can take hours or days to complete,\ndepending on how many businesses you need to load. Note, ``CITY_NAME`` refers to\nstep 4 in configuration. ``REFERENCE_USA_CSV_FILES_DIRECTORY`` refers to step\n2 in configuration above.\n  - $ ./steps.sh \u003cCITY_NAME\u003e \u003cREFERENCE_USA_CSV_FILES_DIRECTORY\u003e\n7. Load ``kibana-dashboard.json``\n  - Navigate to ``http://localhost:5601`` after step 5 completes successfully.\n  - Follow Kibana steps to load the new index name (identified by name in step\n    4) into Kibana. i.e. Management -\u003e Index Patterns -\u003e Create Index Pattern\n  - View the just created index and note in the URL the ID of the index,\n  appearing after the ``kibana/indices/`` prefix. You'll need this ID\n  - Take the ID just obtained above, and replace the existing value ``_id`` with\n  the ID collected above    \n  - Navigate to ``http://localhost:5601/app/kibana#/management/kibana/objects``\n  and click \"import\". Select the file ``kibana-dashboard.json`` and import it.\n\n## Viewing Dashboard\n\nNavigate to: http://localhost:5601/app/kibana#/dashboards and select the\ndashboard titled: ``Business Info Dashboard``. Explore this dashboard and use\nthe search box to find out information about a specific business.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friverma%2Fbosha","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Friverma%2Fbosha","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friverma%2Fbosha/lists"}