simple-resume-parser

KO | EN

gitlite — search

#hacktoberfest #ai #llm #machine-learning #rust #linux #macos #java #windows #cli #awesome-list #security #ios #open-source

simple-resume-parser

(★ 8)

This is a simple NodeJS library to parse PDF, DOCX, DOC and TXT files to extract data based on patterns

simple-resume-parser Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Resume Parser

A Simple NodeJs library to parse Resume files in PDF, DOC, DOCX and TXT format to JSON. If the CVs / Resumes contain any social media profile links then the solution should also parse the public social profile web-pages and organize the data in JSON format (e.g. Linkedin public profile, Github, etc.)

## Installation

`npm install resume-parser --save`

## Usage

```
const ResumeParser = require('simple-resume-parser');

// From file
const resume = new ResumeParser("./files/resume.doc");

// From URL
const resume = new ResumeParser("https://writing.colostate.edu/guides/documents/resume/functionalSample.pdf");

//Convert to JSON Object
  resume.parseToJSON()
  .then(data => {
    console.log('Yay! ', data);
  })
  .catch(error => {
    console.error(error);
  });

//Save to JSON File
resume.parseToFile('converted') //output subdirectory
  .then(file => {
    console.log('Yay! ', file);
  })
  .catch(error => {
    console.error(error);
  });
```

At this moment application will work fine, but! By default it supports only `.TXT` and `.HTML` text formats. For better performance you should install at least support of `.PDF` (and `.DOC`). Here is instructions, how to do it from [textract README](https://github.com/dbashford/textract#requirements) file:

- `PDF` extraction requires `poppler-utils` be installed, [link](https://poppler.freedesktop.org/)
- `DOC` extraction requires `catdoc` be installed, [link](http://www.wagner.pp.ru/~vitus/software/catdoc/), unless on OSX in which case textutil (installed by default) is used.
- `DOCX` extraction requires `antiword` be available (e.g. `sudo apt-get install -y antiword` for Ubuntu)

## Extending

All 'action' are by building `src/dictionary.js` file. For now it has only basics rules, but it's very flexible (although a bit complicated) and extensible. Just put your rule according to existing and following main principles and enjoy!

## Contributions

- This project was originally forked from Perminder Klair's project [https://www.npmjs.com/package/resume-parser](https://www.npmjs.com/package/resume-parser)

simple-resume-parser

simple-resume-parser Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

simple-resume-parser

simple-resume-parser Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README