Metadata-Version: 2.1
Name: crk-orthography
Version: 0.20180728.0
Summary: Convert between Plains Cree SRO and syllabics
Home-page: https://github.com/eddieantonio/crk_orthography
Author: Eddie Antonio Santos
Author-email: easantos@ualberta.ca
License: AGPLv3
Description: 
        Plains Cree Orthography
        =======================
        
        [![Build Status](https://travis-ci.org/eddieantonio/crk_orthography.svg?branch=master)](https://travis-ci.org/eddieantonio/crk_orthography)
        [![Documentation Status](https://readthedocs.org/projects/crk-orthography/badge/?version=stable)](https://crk-orthography.readthedocs.io/en/stable/?badge=stable)
        [![PyPI package](https://img.shields.io/pypi/v/crk_orthography.svg)](https://pypi.org/project/crk_orthography/)
        [![Calver MAJOR.YYYY0M0D.PATCH](https://img.shields.io/badge/calver-MAJOR.YYYY0M0D.PATCH-22bfda.svg)](http://calver.org/)
        
        Convert between nêhiyawêwin/ᓀᐦᐃᔭᐍᐏᐣ (Plains Cree Y-dialect) Standard
        Roman Orthography (SRO) and Canadian Aboriginal syllabics!
        
        Install
        -------
        
            pip install crk_orthography
        
        Usage
        -----
        
        [Visit the full documentation here][documentation]! Confused about
        words like "syllabics", "transliterator", or "orthography"? Visit
        [the glossary][glossary]!
        
        [documentation]: https://crk-orthography.readthedocs.io/en/stable/
        [glossary]: https://crk-orthography.readthedocs.io/en/stable/glossary.html
        
        
        ### As a Python module
        
        Convert SRO to syllabics:
        
            >>> from crk_orthography import sro2syllabics
            >>> sro2syllabics('nêhiyawêwin')
            'ᓀᐦᔭᐍᐏᐣ'
            >>> sro2syllabics('write nêhiyawêwin')
            'write ᓀᐦᐃᔭᐍᐏᐣ'
        
        Convert syllabics to SRO:
        
            >>> from crk_orthography import syllabics2sro
            >>> syllabics2sro('ᐊᒋᒧᓯᐢ')
            'acimosis'
            >>> syllabics2sro(' → ᒪᐢᑫᑯᓯᕽ  ᑎᕒᐁᕀᓬ ')
            ' → maskêkosihk  tireyl '
        
        
        ### On the command line
        
        `crk_orthography` installs two command line programs:
        
        #### sro2syllabics
        
        Use this to convert text from a file or from `stdin` to syllabics.
        
            $ echo "minôs" | sro2syllabics
            ᒥᓅᐢ
            $ sro2syllabics my-file-in-sro.txt
            ᒥᓅᐢ
        
        For more information over its options, type:
        
            sro2syllabics --help
        
        #### syllabics2sro
        
        Use this to convert text from a file or from `stdin` to SRO.
        
            $ echo "ᒥᓅᐢ" | syllabics2sro
            minôs
            $ syllabics2sro my-file-in-syllabics.txt
            minôs
            $ syllabics2sro --macrons my-file-in-syllabics.txt
            minōs
        
        
        For more information over its options, type:
        
            syllabics2sro --help
        
        
        See also
        --------
        
        [nêhiyawêwin syllabics](https://github.com/UAlbertaALTLab/nehiyawewin-syllabics)
        
        
        License
        -------
        
        Copyright (C) 2018 Eddie Antonio Santos
        
        This program is free software: you can redistribute it and/or modify
        it under the terms of the GNU Affero General Public License as
        published by the Free Software Foundation, either version 3 of the
        License, or (at your option) any later version.
        
        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU Affero General Public License for more details.
        
        You should have received a copy of the GNU Affero General Public License
        along with this program.  If not, see <http://www.gnu.org/licenses/>.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.4.0
Description-Content-Type: text/markdown
