Metadata-Version: 1.2
Name: lotecc
Version: 0.1.1
Summary: Convert files between Simplified Chinese and Traditional Chinese.
Home-page: https://github.com/lonsty/lotecc
Author: Allen Shaw
Author-email: lonsty@sina.com
License: MIT license
Description: ======
        LoteCC
        ======
        
        
        .. image:: https://img.shields.io/pypi/v/lotecc.svg
                :target: https://pypi.python.org/pypi/lotecc
        
        .. image:: https://img.shields.io/travis/lonsty/lotecc.svg
                :target: https://travis-ci.com/lonsty/lotecc
        
        .. image:: https://readthedocs.org/projects/lotecc/badge/?version=latest
                :target: https://lotecc.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        
        
        **LoteCC** is a tool to convert files between Simplified Chinese and Traditional Chinese.
        
        * Free software: MIT license
        * Documentation: https://lotecc.readthedocs.io.
        
        Features
        ========
        
        * File or whole project: can convert a single file or all files in your project.
        * Patterns to ignore: use .gitignore syntax to exclude unwanted files.
        
        Usage
        =====
        
        1. To use ``lotecc`` in terminal
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        ::
        
            $ lotecc
        
        Above command is equal to ``$ lotecc -c s2t -i . --ignore .gitignore``. Which convert all files in current directory and subdirectories from Simplified Chinese to Traditional Chinese, excluding files matching the pattern in ``.gitignore``:
        
        - ``-c s2t``: conversion is Simplified Chinese to Traditional Chinese
        - ``-i .``: input is current directory
        - ``--ignore .gitignore``: files excluding files matching the pattern in ``.gitignore``
        
        2. To use ``lotecc`` in a project
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        ::
        
            from lotecc import lote_chinese_conversion as lotecc
        
            lotecc(conversion='s2t',
                   input='.',
                   output=None,
                   in_enc='utf-8',
                   out_enc='utf-8',
                   suffix=None,
                   ignore='.gitignore')
        
        You can get helps by type ``$ lotecc --help`` in terminal::
        
            Options:
              -c, --conversion TEXT  Conversion method between Simplified Chinese and
                                     Traditional Chinese.  [default: s2t]
              -i, --input TEXT       Input file or directory. The default is current dir.
              -o, --output TEXT      Output file or directory. The default is the same as
                                     the source file, which means that the source file
                                     will be overwritten.
              -q, --quiet            Disable screen output.  [default: False]
              --ignore TEXT          Can be a .gitignore syntax file. Also can be one or
                                     more patterns, separated by commas.  [default:
                                     .gitignore]
              --suffix TEXT          Suffix of output filename, add this to keep both the
                                     source file and converted file.
              --in-enc TEXT          Encoding for input.  [default: utf-8]
              --out-enc TEXT         Encoding for output.  [default: utf-8]
              --help                 Show this message and exit.
        
        3. Supported conversions
        ^^^^^^^^^^^^^^^^^^^^^^^^
        
        - ``hk2s``: Traditional Chinese (Hong Kong standard) to Simplified Chinese\n
        - ``s2hk``: Simplified Chinese to Traditional Chinese (Hong Kong standard)\n
        - ``s2t``: Simplified Chinese to Traditional Chinese\n
        - ``s2tw``: Simplified Chinese to Traditional Chinese (Taiwan standard)\n
        - ``s2twp``: Simplified Chinese to Traditional Chinese (Taiwan standard, with phrases)\n
        - ``t2hk``: Traditional Chinese to Traditional Chinese (Hong Kong standard)\n
        - ``t2s``: Traditional Chinese to Simplified Chinese\n
        - ``t2tw``: Traditional Chinese to Traditional Chinese (Taiwan standard)\n
        - ``tw2s``: Traditional Chinese (Taiwan standard) to Simplified Chinese\n
        - ``tw2sp``: Traditional Chinese (Taiwan standard) to Simplified Chinese (with phrases)\n
        
        
        Credits
        =======
        
        * The implement of Simplified and Traditional Chinese conversion depends on `opencc-python`_.
        
        * This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        .. _`opencc-python`: https://github.com/yichen0831/opencc-python
        
        
        =======
        History
        =======
        
        0.1.1 (2020-04-27)
        ==================
        
        Bug fixed:
        
        * Handle error of using incorrect encoding to open a file.
        
        0.1.0 (2020-04-25)
        ==================
        
        First release on PyPI.
        
        Features:
        
        * File or whole project: can convert a single file or all files in your project.
        * Patterns to ignore: use .gitignore syntax to exclude unwanted files.
        
Keywords: lotecc
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
