Metadata-Version: 2.1
Name: vininfo
Version: 1.5.1
Summary: Extracts useful information from Vehicle Identification Number (VIN)
Home-page: https://github.com/idlesign/vininfo
Author: Igor `idle sign` Starikov
Author-email: idlesign@yandex.ru
License: BSD 3-Clause License
Description: vininfo
        =======
        https://github.com/idlesign/vininfo
        
        
        |release| |lic| |ci| |coverage|
        
        .. |release| image:: https://img.shields.io/pypi/v/vininfo.svg
            :target: https://pypi.python.org/pypi/vininfo
        
        .. |lic| image:: https://img.shields.io/pypi/l/vininfo.svg
            :target: https://pypi.python.org/pypi/vininfo
        
        .. |ci| image:: https://img.shields.io/travis/idlesign/vininfo/master.svg
            :target: https://travis-ci.org/idlesign/vininfo
        
        .. |coverage| image:: https://img.shields.io/coveralls/idlesign/vininfo/master.svg
            :target: https://coveralls.io/r/idlesign/vininfo
        
        
        Description
        -----------
        
        *Extracts useful information from Vehicle Identification Number (VIN)*
        
        * Can be used as a standalone console application (CLI).
        * One can also use import it as any other package in your Python code.
        * Gives basic and detailed info (is available) about VIN.
        * Allows VIN checksum verification.
        
        Additional info available for many vehicles from:
        
        * AvtoVAZ
        * Nissan
        * Opel
        * Renault
        
        
        Requirements
        ------------
        
        * Python 3.6+
        * ``click`` package for CLI
        
        
        Usage
        -----
        
        CLI
        ~~~
        
        ``click`` package is required for CLI. You can install ``vininfo`` with ``click`` using::
        
            $ pip install vininfo[cli]
        
        
        .. code-block:: bash
        
            $ vininfo --help
        
            ; Print out VIN info:
            $ vininfo show XTAGFK330JY144213
        
            ; Basic:
            ; Country: USSR/CIS
            ; Manufacturer: AvtoVAZ
            ; Region: Europe
            ; Years: 2018, 1988
            ;
            ; Details:
            ; Body: Station Wagon, 5-Door
            ; Engine: 21179
            ; Model: Vesta
            ; Plant: Izhevsk
            ; Serial: 144213
            ; Transmission: Manual Renault
        
            ; Verify checksum
            $ vininfo check 1M8GDM9AXKP042788
            ; Checksum is valid
        
        
        Python
        ~~~~~~
        
        .. code-block:: python
        
            from vininfo import Vin
        
            vin = Vin('VF1LM1B0H36666155')
        
            vin.country  # France
            vin.manufacturer  # Renault
            vin.region  # Europe
            vin.wmi  # VF1
            vin.vds  # LM1B0H
            vin.vis  # 36666155
        
            annotated = vin.annotate()
            details = vin.details
        
            vin.verify_checksum()  # False
            Vin('1M8GDM9AXKP042788').verify_checksum()  # True
        
        
        Development
        -----------
        
        One can add missing WMI(s) using instructions from ``dicts/wmi.py``:
        ``WMI`` dictionary, that maps WMI strings to manufacturers.
        
        Those manufacturers may be represented by simple strings, or instances of ``Brand``
        subclasses (see ``brands.py``).
        
        If you know how to decode additional information (model, body, engine, etc.)
        encoded in VIN, you may also want to create a so-called `details extractor`
        for a brand.
        
        Details extractors are ``VinDetails`` subclasses in most cases making use of
        ``Detail`` descriptors to represent additional information
        (see ``details/nissan.py`` for example).
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: BSD License
Provides-Extra: cli
