Gurmukhi Utils

Utility libraries for converting, analyzing, and testing Gurmukhi strings.

WIP

These libraries are a work in progress! Note that the API can change unexpectedly when upgrading. Libraries won't use SemVer properly until version 1.0.0 (or in the case of the JavaScript library until version 4.0.0). Please do not use for critical projects yet.

Progress

API	Python	JavaScript	Ruby	C Sharp	Dart
unicode to ascii	✅	✅	✅
ascii to unicode	✅	✅	✅		✅
normalize unicode	✅	✅	✅		✅

Install

Python (PyPI)

pip3 install gurmukhiutils

poetry add gurmukhiutils

Ruby (RubyGems)

gem install gurmukhi_utils

gem 'gurmukhi_utils', '~> 0.0.3'

Dart (pub.dev)

dart pub add gurmukhi_utils

Contribute

If you want to help, please get started with the CONTRIBUTING.md doc in the respective language of choice.

Contributing Docs

• Python
• JavaScript
• Ruby
• C# / C Sharp
• Dart

Helpful Tools

• Unicode Resources Online Tools has a lot of good ones such as:
  • Unicode Code Converter
  • Unicode Breaks (Segmentation)
• Sarabveer's Gurmukhi Unicode Converter

Community

The easiest way to communicate is via GitHub issues. Please search for similar issues regarding your concerns before opening a new issue.

Get organization updates for Shabad OS by following us on Instagram and Twitter. We also invite you to join us on our public chat server hosted on Slack.

Our intention is to signal a safe open-source community. Please help us foster an atmosphere of kindness, cooperation, and understanding. By participating, you agree to abide by the Contributor Covenant.

If you have a concern that doesn't warrant opening a GitHub issue, please reach out to us:

Harjot Singh, Organization Lead: @Harjot1Singh

Bhajneet S.K., Python/JavaScript Maintainer: @bhajneet

Dilraj Singh, Ruby Maintainer: @dsomel21

Onkarjit Singh, C# / C Sharp Maintainer: @onkarjit

Akshdeep Singh, Dart Maintainer: @akshdeep-singh