{"id":22493577,"url":"https://github.com/bigsk1/employ","last_synced_at":"2025-03-31T00:19:46.077Z","repository":{"id":197702235,"uuid":"699123343","full_name":"bigsk1/employ","owner":"bigsk1","description":"get an overall ranking score for a business from various resources","archived":false,"fork":false,"pushed_at":"2024-11-27T04:01:20.000Z","size":840,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T17:51:15.513Z","etag":null,"topics":["bbb-api","business-analytics","business-tools","google-places-api","jobsearch","ranking-algorithm","ranking-system","rankings","rating-system","ratings","yelp-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bigsk1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"bigsk1"}},"created_at":"2023-10-02T00:59:34.000Z","updated_at":"2024-11-27T04:01:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"3f683f52-7c2d-4154-900a-43639e880e41","html_url":"https://github.com/bigsk1/employ","commit_stats":null,"previous_names":["bigsk1/employ"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigsk1%2Femploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigsk1%2Femploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigsk1%2Femploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigsk1%2Femploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigsk1","download_url":"https://codeload.github.com/bigsk1/employ/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246396515,"owners_count":20770382,"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":["bbb-api","business-analytics","business-tools","google-places-api","jobsearch","ranking-algorithm","ranking-system","rankings","rating-system","ratings","yelp-api"],"created_at":"2024-12-06T18:54:44.400Z","updated_at":"2025-03-31T00:19:46.048Z","avatar_url":"https://github.com/bigsk1.png","language":"Python","funding_links":["https://github.com/sponsors/bigsk1"],"categories":[],"sub_categories":[],"readme":"# Employ - Business Ranking\n[![last commit](https://img.shields.io/github/last-commit/bigsk1/employ)](https://img.shields.io/github/last-commit/bigsk1/employ)\n[![Unit Tests](https://img.shields.io/github/actions/workflow/status/bigsk1/employ/python-app.yml?label=unit%20tests)](https://github.com/bigsk1/employ/actions/workflows/python-app.yml)\n\nGet an overall ranking score for a business from various resources in one place\n\n## Overview\n\nThe Employ Rating System is a web and cli application designed to calculate and display the overall rating of businesses based on various data points. The application fetches ratings from multiple sources like Yelp, Google Places, and BBB, and calculates a weighted average to provide an overall score for a business.\n\n![Employ Logo](./images/employ.png)\n\n\n## Features\n\n- **User Interface**: A web-based UI that allows users to input business details and view the calculated ratings.\n- **Configurable Weights**: Users can configure the weightage given to each rating source.\n- **Log Management**: The application logs all the rating details and API responses for debugging and transparency.\n- **Data Persistence**: Uses YAML files to store configuration settings.\n- **Downloadable Logs**: Users can download the log files for offline analysis.\n\n## Installation\n\nWinodws or Linux\n\n### Prerequisites\n\n- Python 3.x\n- Docker (optional)\n- Conda (optional for environment management)\n\n### Local Setup\n\n#### Using Python's built-in venv\n\n1. Clone the repository\n\n```bash\ngit clone https://github.com/bigsk1/employ.git\n```\n\n2. Navigate to the project directory\n\n```bash\ncd employ\n```\n\n3. Create a virtual environment\n\n```bash\npython -m venv .venv\n```\n\n4. Activate the virtual environment\n- On Windows:\n\n ```bash\n.venv\\Scripts\\activate\n```\n\n- On macOS and Linux:\n\n ```bash\nsource .venv/bin/activate\n```\n\n5. Install required packages\n\n```bash\npip install -r requirements.txt\n```\n\n6. Run the application\n\n```bash\npython app.py\n```\n\n#### You can also run from CLI python main.py and get output in terminal\n\n#### Using Conda\n\n1. Install [Conda](https://docs.anaconda.com/anaconda/install/) if you haven't already.\n2. Create a new Conda environment\n\n    ```bash\n    conda create -n employ python=3.11.0\n    ```\n\n3. Activate the Conda environment\n\n    ```bash\n    conda activate employ\n    ```\n\n4. Follow steps 1, 2, 5, and 6 from the \"Using Python's built-in venv\" section.\n\n### Docker\n\n1. Docker image\n\n```bash\ndocker pull bigsk1/employ:latest\n```\n\n2. Use the provided `docker-compose.yml` file to start the container.\n\n ```bash\ndocker-compose up\n```\n\nOR\n\n3. Use a docker run command instead, add additional -e as needed\n\n```bash\ndocker run --restart=always -p 5000:5000 -e YELP_API_KEY=yourkey bigsk1/employ:latest\n```\n\nvisit localhost:5000\n## Usage\n\n1. Open your web browser and navigate to `http://localhost:5000`.\n2. Input the business details and configure the weights for each rating source.\n3. Click the \"Run\" button to fetch the ratings and calculate the overall score.\n\n## Environment Variables\n\nThe application uses the following environment variables for API access:\n\n- `YELP_API_KEY`\n- `GOOGLE_API_KEY`\n- `BBB_API_TOKEN`\n\nThese can be set in a `.env` file in the project directory.\n\nYou need to sign up and get the API keys and tokens to use the those options\n\n## Future Additions\n\n- Integration of more APIs to enhance the business ranking system.\n- Incorporation of awards or recognitions that could positively influence a business's score.\n- Adapt the tool for job seekers to evaluate potential employers.\n- Add manual entry fields for other factors important in business evaluation.\n- Implement industry-specific ranking systems with different weights or criteria.\n\n## Contributing\n\nFeel free to open issues or submit pull requests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigsk1%2Femploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigsk1%2Femploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigsk1%2Femploy/lists"}