{"id":13852511,"url":"https://github.com/zeshuaro/LinkedRW","last_synced_at":"2025-07-13T05:33:22.542Z","repository":{"id":62576239,"uuid":"184498578","full_name":"zeshuaro/LinkedRW","owner":"zeshuaro","description":"A simple CLI to create your resume and personal website based on your LinkedIn profile or a JSON file","archived":true,"fork":false,"pushed_at":"2022-01-02T11:58:47.000Z","size":1374,"stargazers_count":109,"open_issues_count":0,"forks_count":15,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-05-01T16:10:17.341Z","etag":null,"topics":["cv","javascript","latex","linkedin","personal-website","portfolio","profile","python","resume"],"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/zeshuaro.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}},"created_at":"2019-05-02T00:17:01.000Z","updated_at":"2023-11-21T13:43:03.000Z","dependencies_parsed_at":"2022-11-03T20:45:46.160Z","dependency_job_id":null,"html_url":"https://github.com/zeshuaro/LinkedRW","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeshuaro%2FLinkedRW","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeshuaro%2FLinkedRW/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeshuaro%2FLinkedRW/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeshuaro%2FLinkedRW/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeshuaro","download_url":"https://codeload.github.com/zeshuaro/LinkedRW/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225861619,"owners_count":17535981,"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":["cv","javascript","latex","linkedin","personal-website","portfolio","profile","python","resume"],"created_at":"2024-08-04T22:01:23.359Z","updated_at":"2024-11-22T07:30:30.094Z","avatar_url":"https://github.com/zeshuaro.png","language":"Python","funding_links":[],"categories":["Python","HarmonyOS"],"sub_categories":["Windows Manager"],"readme":"### ⚠️ This app is no longer maintained. ⚠️\n\n# LinkedRW\n\n[![PyPi Package Version](https://img.shields.io/pypi/v/linkedrw.svg)](https://pypi.org/project/linkedrw/)\n[![Supported Python Versions](https://img.shields.io/pypi/pyversions/linkedrw.svg)](https://pypi.org/project/linkedrw/)\n[![MIT License](https://img.shields.io/pypi/l/linkedrw.svg)](https://github.com/zeshuaro/LinkedRW/blob/master/LICENSE)\n\n[![Build Status](https://travis-ci.com/zeshuaro/LinkedRW.svg?branch=master)](https://travis-ci.com/zeshuaro/LinkedRW)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/04b86b6463f749f79378ca580257fbb7)](https://www.codacy.com/app/zeshuaro/LinkedRW?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=zeshuaro/LinkedRW\u0026amp;utm_campaign=Badge_Grade)\n[![codecov](https://codecov.io/gh/zeshuaro/linkedRW/branch/master/graph/badge.svg)](https://codecov.io/gh/zeshuaro/linkedRW)\n\nA simple CLI for you to create your resume using the [Awesome CV](https://github.com/posquit0/Awesome-CV) template, \nand your personal website using the [Dev Portfolio](https://github.com/RyanFitzgerald/devportfolio) template, \nbased on your LinkedIn profile.\n\n## Installation\n\nInstall through pip:\n\n```bash\npip install linkedrw\n```\n\nYou will also need to download a web driver. You can either put it in path (e.g. `/usr/local/bin/`) or specify it by using the `-dp/--driver_path` option, `linkedrw` supports the following: \n\n* [Chrome Driver](https://sites.google.com/a/chromium.org/chromedriver/downloads)\n* [Firefox Driver](https://github.com/mozilla/geckodriver/releases)\n* [Opera Driver](https://github.com/operasoftware/operachromiumdriver/releases)\n* Safari Driver ([Instructions](https://webkit.org/blog/6900/webdriver-support-in-safari-10/) to configure Safari to allow automation)\n\n## Usage\n\nSimply run `linkedrw` to create your resume and personal webiste:\n\nThis will create three outputs:\n\n`profile.json` - Your LinkedIn profile is being scraped and stored in this file\n\n`resume/` - The directory containing your resume files\n\n`website/` - The directory containing your personal website files\n\n### Running Without LinkedIn\n\nScraping from LinkedIn allows you to only manage and update your profile there \nwhile keeping your resume and personal website up-to-date. \nHowever, you can also create your resume and personal website by using a JSON file.\nCheck out the example [here](example.json) for the JSON format that `linkedrw` accepts.\nOnce you have your JSON profile ready, run the following command to create your resume and personal website:\n\n```bash\nlinkedrw -j example.json\n```\n\n### Compiling Your Resume\n\nThe `resume/` directory contains a list of LaTex files that can be compiled into a PDF resume file. \nAs per the instructions and requirements from [Awesome-CV](https://github.com/posquit0/Awesome-CV), \na full TeX distribution needs to be installed to compile the LaTex files. \nYou can download and install it from [here](https://www.latex-project.org/get/#tex-distributions).\n\nPlease note that `linkedrw` will try to compile the LaTex files for you if the requirements are met.\n\nAfter installing the TeX distribution, run the following commands to compile your resume:\n\n```bash\ncd resume/\nxelatex resume.tex\n```\n\nThis should create your PDF resume file `resume.pdf`\n\nIf your resume contains a publication section, \n[**BibLaTeX**](https://www.ctan.org/pkg/biblatex) and [**biber**](https://www.ctan.org/pkg/biber) should also be available. \nAnd run the following commands instead:\n\n```bash\ncd resume/\nxelatex resume.tex\nbiber resume\nxelatex resume.tex\n```\n\n### Personal Website\n\nSimply navigate to the `website/` directory and open `index.html` in a web browser, \nand you should be able to see your personal website.\n\n### Options\n\nBelow is the list of options:\n\n```text\n  -h, --help            show this help message and exit\n  --email EMAIL, -e EMAIL\n                        Your LinkedIn login email\n  --password PASSWORD, -p PASSWORD\n                        Your LinkedIn login password\n  --keep_creds, -k      Store LinkedIn login credentials under\n                        ~/.linkedrw/credentials.json\n  --output_dir OUTPUT_DIR, -o OUTPUT_DIR\n                        The output directory (default: current directory)\n  --scrape_only, -s     Only scrape LinkedIn profile\n  --resume_only, -r     Only create resume\n  --website_only, -w    Only create personal website\n  --profile PROFILE_FILE, -j PROFILE_FILE\n                        The profile json file\n  --driver DRIVER, -d DRIVER\n                        The web driver: chrome, firefox, safari, opera\n                        (default: chrome)\n  --driver_path DRIVER_PATH, -dp DRIVER_PATH\n                        The executable path of the web driver\n  --timeout TIMEOUT, -t TIMEOUT\n                        The timeout value (default: 10)\n```\n\n## Customisation\n\n### Customising Your Resume\n\nThe comments in `resume.pdf` give you guidelines on customising your resume.\n\n### Customising Your Personal Website\n\nRun the following commands to install the dependencies first:\n\n```bash\ncd website/\nnpm install\n```\n\nThen run the following command so that it can be auto compiled when there are changes made to `js/scripts.js` or `sass/styles.css`:\n\n```bash\nnpm run watch\n```\n\nFor more customisation instructions, please refer to the original [repo](https://github.com/RyanFitzgerald/devportfolio).\n\n## Issues\n\nIf `NoSuchElementException` is raised, try increasing the timeout value by specifying `-t/--timeout` option.\nIf the problem remains, please raise an issue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeshuaro%2FLinkedRW","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeshuaro%2FLinkedRW","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeshuaro%2FLinkedRW/lists"}