Skip to content

Latest commit

 

History

History
79 lines (46 loc) · 2.87 KB

README.md

File metadata and controls

79 lines (46 loc) · 2.87 KB
Raw

SKU Generator

SKU-Generator.py is a script generates unique SKU codes based on a CSV file with columns containing product information.

It also includes a function to replace colors with color codes.

SKU (Stock Keeping Unit) is a unique identifier that is used to track inventory in warehouses, retail stores, or even eCommerce stores.

SKU can be used to populate item code in many accounting software such as Manager.io.

Features

  • Generate SKUs based on custom rules and templates
  • Automatically assign sequential numbers to SKUs to ensure uniqueness
  • Support for a wide range of attribute types, including strings, numbers, and dates
  • Configurable delimiter characters between attributes in SKUs
  • Export generated SKUs to a CSV file for easy integration into other systems

Requirements

The script was developed using Python3 (3.11) in a virtual environment.

Should you want to use this script, ensure your machine support any version of python3.

Additionally, run this command in your terminal to fulfill the script dependencies:

pip install -r requirements.txt

Usage

Fork this repo

Click the "Fork" icon in the upper right of the page.

This will create a fork of the project under your user account.

Cloning it locally

Next, clone your local version down to your local machine:

git clone https://github.com/<Your-GitHub-Username>/sku-generator.git

Alternatively, you can simply download the project as ZIP file and unzip it to use as depicted below:

Clone or Download project as ZIP file.

User Guide

  1. Open the CHARTS directory and customize two CSV files namely categories-subcategories.csv and colors.csv according to your use case scenario in any text editor (Excel spreadsheet or Notepad).
  2. Next, fill in your product info in the sku_gen_template.csv accordingly.
  3. Run the sku-gen.py script in the terminal. Open your terminal and navigate to the script directory, then enter:
python sku-gen.py
  1. Your result will be saved in the same folder of sku-gen.py with the following name:
sku_gen_template_result.csv

For more information on how to use SKU-Generator, please refer to the documentation.

Contributing

If you would like to contribute to SKU-Generator, please submit a pull request with your changes. Before submitting a pull request, please make sure that your changes are covered by unit tests and follow the code style guidelines.

License

SKU-Generator is licensed under the MIT license. See the LICENSE file for more information.

By contributing, you agree that your contributions will be licensed under its MIT License.