Metadata-Version: 2.1
Name: rev_ai
Version: 2.2.2
Summary: Rev.ai makes speech applications easy to build!
Home-page: https://github.com/revdotcom/revai-python-sdk
Author: Rev Ai
License: MIT license
Description: # Rev.ai Python SDK
        
        [![Build Status](https://img.shields.io/travis/revdotcom/revai-python-sdk.svg?branch=master)](https://travis-ci.org/revdotcom/revai-python-sdk)
        
        ## Documentation
        
        See the [API docs](https://www.rev.ai/docs) for more information about the API and
        more python examples.
        
        ## Installation
        
        You don't need this source code unless you want to modify the package. If you just
        want to use the package, just run:
        
            pip install --upgrade rev_ai
        
        Install from source with:
        
            python setup.py install
        
        ### Requirements
        
        - Python 2.7+ or Python 3.4+
        
        ## Usage
        
        All you need to get started is your Access Token, which can be generated on
        your [Settings Page](https://www.rev.ai/settings). Create a client with the 
        given Access Token:
        
        ```python
        from rev_ai import apiclient
        
        # create your client
        client = apiclient.RevAiAPIClient("ACCESS TOKEN")
        ```
        
        ### Sending a file
        
        Once you've set up your client with your Access Token sending a file is easy!
        
        ```python
        # you can send a local file
        job = client.send_job_local_file("FILE PATH")
        
        # or send a link to the file you want transcribed
        job = client.send_job_url("https://url-of-my-file")
        ```
        
        `job` will contain all the information normally found in a successful response from our
        [Submit Job](https://www.rev.ai/docs#operation/SubmitTranscriptionJob) endpoint.
        
        If you want to get fancy, both send job methods take `metadata`, `callback_url`, and a boolean
        `skip_diarization` as optional parameters, these are also described in the request body of
        the [Submit Job](https://www.rev.ai/docs#operation/SubmitTranscriptionJob) endpoint.
        
        ### Checking your file's status
        
        You can check the status of your transcription job using its `id`
        
        ```python
        job_details = client.get_job_details(job.id)
        ```
        
        `job_details` will contain all information normally found in a successful response from
        our [Get Job](https://www.rev.ai/docs#operation/GetJobById) endpoint
        
        ### Getting your transcript
        
        Once your file is transcribed, you can get your transcript in a few different forms: 
        
        ```python
        # as text
        transcript_text = client.get_transcript_text(job.id)
        
        # as json
        transcript_json = client.get_transcript_json(job.id)
        
        # or as a python object
        transcript_object = client.get_transcript_object(job.id)
        ```
        
        Both the json and object forms contain all the formation outlined in the response
        of the [Get Transcript](https://www.rev.ai/docs#operation/GetTranscriptById) endpoint
        when using the json response schema. While the text output is a string containing 
        just the text of your transcript
        
        
        =======
        History
        =======
        
        0.0.0 (2018-09-28)
        ------------------
        
        * Initial alpha release
        
        2.1.0
        ------------------
        
        * Revamped official release
        
        2.1.1
        ------------------
        
        * File upload bug fixes
        
        2.2.1
        ------------------
        
        * Better Documentation
        
        2.2.2
        ------------------
        
        * Fix pypi readme formatting
Keywords: rev_ai
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
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
Description-Content-Type: text/markdown
