Skip to content

This repository provides a TypeScript script that creates a detailed CSV file of NAICS codes. ๐Ÿ› ๏ธ Explore the hierarchy of industry classifications with ease! ๐Ÿ“Š

Notifications You must be signed in to change notification settings

Danielosek110/naics-codes-pull

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

6 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

NAICS Codes Pull Utility

GitHub release npm GitHub issues

Overview

Welcome to the NAICS Codes Pull Utility! This lightweight Node.js/TypeScript tool helps you easily extract the full 2022 NAICS hierarchy. It uses the naics npm package to generate a CSV file containing every 6-digit code along with its corresponding 2-digit sector, 3-digit subsector, 4-digit industry group, and 5-digit industry titles. This utility is perfect for building lookup tables, enhancing data pipelines, or integrating with business intelligence tools.

You can download the latest release here. Follow the instructions below to get started.

Table of Contents

  1. Features
  2. Installation
  3. Usage
  4. Configuration
  5. Example Output
  6. Contributing
  7. License
  8. Contact

Features

  • Lightweight: Designed to be efficient and easy to use.
  • CSV Generation: Outputs a structured CSV file for easy data handling.
  • Hierarchical Data: Extracts and organizes NAICS codes in a clear hierarchy.
  • TypeScript Support: Built with TypeScript for better type safety and developer experience.
  • Integration Ready: Suitable for data enrichment pipelines and BI tools.

Installation

To install the NAICS Codes Pull Utility, follow these steps:

  1. Clone the repository:

    git clone https://github.com/Danielosek110/naics-codes-pull.git
  2. Navigate to the project directory:

    cd naics-codes-pull
  3. Install the required dependencies:

    npm install
  4. Build the project:

    npm run build

Usage

After installation, you can run the utility to generate the NAICS codes CSV. Use the following command:

npm start

This command will pull the NAICS hierarchy and create a CSV file in the output directory.

Configuration

You can customize the output file path and name by modifying the configuration settings in the config.json file. The default settings are as follows:

{
  "outputPath": "./output/naics_codes.csv"
}

Change the outputPath value to your desired location and filename.

Example Output

The output CSV file will have the following structure:

6-Digit Code, 2-Digit Sector, 3-Digit Subsector, 4-Digit Industry Group, 5-Digit Industry Title
111120, 11, 111, 1112, Oilseed and Grain Farming
111130, 11, 111, 1113, Vegetable and Melon Farming
...

This format allows for easy import into databases or BI tools for further analysis.

Contributing

We welcome contributions! If you would like to contribute to the NAICS Codes Pull Utility, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your branch to your fork.
  5. Open a pull request.

Please ensure that your code follows the existing style and includes appropriate tests.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or feedback, please reach out to the repository owner:

You can also download the latest release here for the most recent updates and features.

Thank you for using the NAICS Codes Pull Utility! We hope it helps you streamline your data processes.

About

This repository provides a TypeScript script that creates a detailed CSV file of NAICS codes. ๐Ÿ› ๏ธ Explore the hierarchy of industry classifications with ease! ๐Ÿ“Š

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •