Skip to content

Commit 43f42e7

Browse files
committed
updated README.md
1 parent b458776 commit 43f42e7

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- # cvscan
1+
# cvscan
22
Your not so typical resume parser
33
Instructions
44
========
@@ -25,6 +25,7 @@ cvscan add -s "C,C++,R,Java"
2525
```
2626
cvscan remove --skill "C,C++"
2727
```
28+
2829
## Jobs
2930
### add
3031
Adding
@@ -41,6 +42,7 @@ Removing
4142
```
4243
cvscan remove --job "contributor,Android Programmer"
4344
```
45+
4446
## Organizations
4547
### add
4648
```
@@ -50,10 +52,12 @@ cvscan add --org "Skcript"
5052
```
5153
cvscan remove -o "Skcript"
5254
```
55+
5356
## Qualifications
5457
Note:
5558
* Qualifications are case-sensitive.
5659
* Puntuations before the first and after the last alphabet should be excluded
60+
5761
### add
5862
```
5963
cvscan add -q "B.S,B.Tech,B.Arch"
@@ -62,6 +66,7 @@ cvscan add -q "B.S,B.Tech,B.Arch"
6266
```
6367
cvscan remove --qual "B.Arch"
6468
```
69+
6570
## Extra Information
6671
### add
6772
```
@@ -71,6 +76,7 @@ cvscan add -e "machine learning,artificial intelligence"
7176
```
7277
cvscan remove --extra "machine learning,artificial intelligence"
7378
```
79+
7480
File Descriptions
7581
============
7682
## class Cvscan
@@ -86,9 +92,8 @@ cvscan.extract()
8692
```
8793
cvscan.show()
8894
```
89-
-->
9095
### Attributes
91-
| Attributes | Functions |
96+
| Attributes | Function |
9297
|---------------------|-----------|
9398
|path | Stores the path of the resume |
9499
|raw_text | Stores the resume as raw text |
@@ -98,16 +103,21 @@ cvscan.show()
98103
|Phone number | Applicant's contact number |
99104
|address | Applicant's address |
100105
|experience | Applicant's experience in years |
101-
|cleaned_resume | raw_text after removing english stopwords |
106+
|cleaned_resume | Raw text after removing english stopwords |
102107
|skills | Applicant's skillset |
103108
|qualifications | Applicant's qualifications |
104-
|degree_info | info about qualification |
105-
|
106-
109+
|degree_info | Info about qualification |
110+
|job_positions | Applicant's jobs |
111+
|category | Applicant's Job category |
112+
|current_employers | Organization applicant is working in |
113+
|employers | All organizations applicant has worked in |
114+
|extra_info | Extra information about the applicant|
115+
<!--
107116
## configurations.py
108117
Contains the regular expressions used throughout the project
109118
## converter.py
110119
Contains methods to convert resume from input format to raw text
111120
#### pdf_to_text
112121
Uses pdfminer library to fetch raw text from the resume. Special characters and bullets in the resume are replaced with a newline character.
113122
This formatted text from the resume is returned.
123+
-->

0 commit comments

Comments
 (0)