/os-docid

DocID for fun.

Primary LanguagePythonMIT LicenseMIT

os-docid

Build Status codecov PyPI - Python Version PyPI

DocID for fun.

Install

$ pip install os-docid

Usage

  • API

    >>> from os_docid import docid
    
    >>> docid('http://www.google.com/')
    1d5920f4b44b27a8-ed646a3334ca891f-ff90821feeb2b02a33a6f9fc8e5f3fcd
    
    >>> docid('1d5920f4b44b27a8-ed646a3334ca891f-ff90821feeb2b02a33a6f9fc8e5f3fcd')
    1d5920f4b44b27a8-ed646a3334ca891f-ff90821feeb2b02a33a6f9fc8e5f3fcd
    
    >>> docid('1d5920f4b44b27a8ed646a3334ca891fff90821feeb2b02a33a6f9fc8e5f3fcd')
    1d5920f4b44b27a8-ed646a3334ca891f-ff90821feeb2b02a33a6f9fc8e5f3fcd
    
    >>> docid('abc')  
    NotImplementedError: Not supported data format
    
    
  • Command line

    $ os-docid -h
    usage: os-docid [-h] [-v] [-f FILES [FILES ...]]
    
    Generate DocID.
    
    optional arguments:
      -h, --help            show this help message and exit
      -v, --version         show program's version number and exit
      -f FILES [FILES ...], --files FILES [FILES ...]
                            files to be process (default: stdin)
    

Unit Tests

$ tox

License

MIT licensed.