Metadata-Version: 2.1
Name: charset_normalizer
Version: 0.2.2
Summary: The Real First Universal Charset Detector. Offer a viable solution alternative to Chardet.
Home-page: https://github.com/ousret/charset_normalizer
Author: Ahmed TAHRI @Ousret
Author-email: ahmed.tahri@cloudnursery.dev
License: MIT
Description: 
        <h1 align="center">Welcome to Charset for Human 👋</h1>
        
        <p align="center">
          <sup>The Real First Universal Charset Detector</sup><br>
          <a href="https://travis-ci.org/Ousret/charset_normalizer">
            <img src="https://travis-ci.org/Ousret/charset_normalizer.svg?branch=master"/>
          </a>
          <img src="https://img.shields.io/pypi/pyversions/charset_normalizer.svg?orange=blue" />
          <img src="https://img.shields.io/pypi/dm/charset_normalizer.svg"/>
          <a href="https://github.com/ousret/charset_normalizer/blob/master/LICENSE">
            <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-purple.svg" target="_blank" />
          </a>
          <a href="https://app.codacy.com/project/Ousret/charset_normalizer/dashboard">
            <img alt="Code Quality Badge" src="https://api.codacy.com/project/badge/Grade/a0c85b7f56dd4f628dc022763f82762c"/>
          </a>
          <a href="https://codecov.io/gh/Ousret/charset_normalizer">
              <img src="https://codecov.io/gh/Ousret/charset_normalizer/branch/master/graph/badge.svg" />
          </a>
        </p>
        
        > Library that help you read text from unknown charset encoding.<br /> Project motivated by `chardet`, I'm trying to resolve the issue by taking another approach.
        
        This project offer you a alternative to **Universal Charset Encoding Detector**, also known as **Chardet**.
        
        | Feature       | [Chardet](https://github.com/chardet/chardet)       | Charset Normalizer | [cChardet](https://github.com/PyYoshi/cChardet) |
        | ------------- | :-------------: | :------------------: | :------------------: |
        | `Fast`         | ❌<br> 🐌🐌         | ❌<br> 🐌             | ✅ <br>⚡ |
        | `Universal**`     | ❌            | ✅                 | ❌ |
        | `Reliable` **without** distinguishable standards | ❌ | ✅ | ✅ |
        | `Reliable` **with** distinguishable standards | ✅ | ✅ | ✅ |
        | `Free & Open`  | ✅             | ✅                | ✅ |
        | `Native Python` | ✅ | ✅ | ❌ |
        | `Detect spoken language` | ❌ | ✅ | N/A |
        
        <p align="center">
        <img src="https://i.imgflip.com/373iay.gif" alt="Reading Normalized Text" width="226"/><img src="https://image.noelshack.com/fichiers/2019/31/5/1564761473-ezgif-5-cf1bd9dd66b0.gif" alt="Cat Reading Text" width="200"/>
        
        *\*\* : They are clearly using specific code for a specific charset even if covering most of existing one*<br>
        
        ## Your support
        
        Please ⭐ this repository if this project helped you!
        
        ## ✨ Installation
        
        Using PyPi
        ```sh
        pip install charset_normalizer
        ```
        
        ## 🚀 Basic Usage
        
        ### CLI
        This package come with a CLI
        
        ```
        usage: normalizer [-h] [--verbose] [--normalize] [--replace] [--force]
                          file [file ...]
        
        positional arguments:
          file         Filename
        
        optional arguments:
          -h, --help   show this help message and exit
          --verbose    Display complementary information about file if any.
          --normalize  Permit to normalize input file. If not set, program does not
                       write anything.
          --replace    Replace file when trying to normalize it instead of creating a
                       new one.
          --force      Replace file without asking if you are sure, use this flag with
                       caution.
        ```
        
        ```bash
        normalizer ./data/sample.1.fr.srt
        ```
        
        ```
        +----------------------+----------+----------+------------------------------------+-------+-----------+
        |       Filename       | Encoding | Language |             Alphabets              | Chaos | Coherence |
        +----------------------+----------+----------+------------------------------------+-------+-----------+
        | data/sample.1.fr.srt |  cp1252  |  French  | Basic Latin and Latin-1 Supplement | 0.0 % |  84.924 % |
        +----------------------+----------+----------+------------------------------------+-------+-----------+
        ```
        
        ### Python
        *Just print out normalized text*
        ```python
        from charset_normalizer import CharsetNormalizerMatches as CnM
        print(CnM.from_path('./my_subtitle.srt').best().first())
        ```
        
        *Normalize any text file*
        ```python
        from charset_normalizer import CharsetNormalizerMatches as CnM
        try:
            CnM.normalize('./my_subtitle.srt') # should write to disk my_subtitle-***.srt
        except IOError as e:
            print('Sadly, we are unable to perform charset normalization.', str(e))
        ```
        
        See wiki for advanced usages. *Todo, not yet available.*
        
        ## 😇 Why
        
        When I started using Chardet, I noticed that this library was wrong most of the time 
        when it's not about Unicode, Gb or Big5. That because some charset are easily identifiable 
        because of there standards and Chardet does a really good job at identifying them.
        
        I **don't care** about the **originating charset** encoding, that because **two different table** can 
        produce **two identical file.**
        What I want is to get readable text, the best I can.
        
        In a way, **I'm brute forcing text decoding.** How cool is that ? 😎
        
        ## 🍰 How
        
          - Discard all charset encoding table that could not fit the binary content.
          - Measure chaos, or the mess once opened with a corresponding charset encoding.
          - Extract matches with the lowest mess detected.
          - Finally, if there is too much match left, we measure coherence.
        
        **Wait a minute**, what is chaos/mess and coherence according to **YOU ?**
        
        *Chaos :* I opened hundred of text files, **written by humans**, with the wrong encoding table. **I observed**, then 
        **I established** some ground rules about **what is obvious** when **it's seems like** a mess.
         I know that my interpretation of what is chaotic is very subjective, feel free to contribute in order to 
         improve or rewrite it.
         
         *Coherence :* For each language there is on earth (the best we can), we have computed letter appearance occurrences ranked. So I thought that
         those intel are worth something here. So I use those records against decoded text to check if I can detect intelligent design.
         
        ## 👤 Contributing
        
        Contributions, issues and feature requests are very much welcome.<br />
        Feel free to check [issues page](https://github.com/ousret/charset_normalizer/issues) if you want to contribute.
        
        ## 📝 License
        
        Copyright © 2019 [Ahmed TAHRI @Ousret](https://github.com/Ousret).<br />
        This project is [MIT](https://github.com/Ousret/charset_normalizer/blob/master/LICENSE) licensed.
        
        Letter appearances frequencies used in this project © 2012 [Denny Vrandečić](http://denny.vrandecic.de)
Keywords: encoding,i18n,txt,text,charset,charset-detector,normalization,unicode,chardet
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
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 :: 3.8
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.4.0
Description-Content-Type: text/markdown
Provides-Extra: permit to generate frequencies.json
