Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peaske7/parse-universities
A collection of node scripts to clean csv data and output usable json files on colleges and universities in the U.S.
https://github.com/peaske7/parse-universities
csv parser
Last synced: 3 days ago
JSON representation
A collection of node scripts to clean csv data and output usable json files on colleges and universities in the U.S.
- Host: GitHub
- URL: https://github.com/peaske7/parse-universities
- Owner: peaske7
- Created: 2021-01-31T02:01:08.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-09T14:21:39.000Z (over 3 years ago)
- Last Synced: 2024-12-19T19:13:39.774Z (about 2 months ago)
- Topics: csv, parser
- Language: JavaScript
- Homepage:
- Size: 28.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🏫 Parse Univerisity Data
## ❓What is this?
There is an abundance of useful information concerning colleges and universities collected by government agencies. However, you don't need all the info they provide, just the stuff that's really important. So, I parse-universities is an attempt to simplify the process, and also converts csv to json for better ease of implementation in existing js based code bases.
## 🔭 Future Intentions
I intend on writing a more detailed documentation for the different parser functions, and a better quick start guide.
## 🚀 Quick Start
First, install the necessary npm dependencies for the project
```
npm install
```
Then, write the parser functions you wish. An example could be something like the following.
```
const parseSchools = require('./parsers/parseSchools.js')
parseSchools.parseForSchools(1, 10, 1)
```
Run the paser functions you wrote in index.js, and run.
```
node index.js
```
Create a folder named 'output' in the root directory, and write the following.
```
const parseMajors = require('./parsers/parseMajors.js')
parseMajors.parseMajorsWithMap('./output/majors/schoolsInFile1.json')
```
Run the parser function.
```
node index.js
```
In the end, the index.js file should like below.
```
const parseShools = require('./parsers/parseShools.js')
const parseMajors = require('./parsers/parseMajors.js')
parseSchools.parseForSchools(1, 10, 1)
parseMajors.parseMajorsWithMap('./output/majors/schoolsInFile1.json')
```
## 🔮 Parsers
I've written a couple different parser functions that serve different uses.
### Parse CIP CSV and convert to JSON
Check [parsers/parseCIPLookup.js](https://github.com/DrPoppyseed/parse-universities/blob/main/parsers/parseCIPLookup.js).
Parses through [csv/cip/cipraw.csv](#) and outputs json file with the major's cipcode, name, and description, in the following format.
```
[
...,
{
"cipcode": "52.0305",
"major": "Accounting and Business/Management",
"description": "An integrated or combined program in accounting and business administration/management that prepares individuals to function as accountants and business managers."
},
...
]
```
### Parse Majors with Stats
Check [parsers/parseMajors.js](https://github.com/DrPoppyseed/parse-universities/blob/main/parsers/parseMajors.js)
*Documentation coming soon*
### Parse Schools (Run this before using parseMajors)
Check [parsers/parseSchools.js](https://github.com/DrPoppyseed/parse-universities/blob/main/parsers/parseSchools.js)
*Documentation coming soon*