mtai


Namemtai JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/mediatranscribe/mt-ai-python
SummaryA python library to consume meditranscribe ai API
upload_time2024-06-22 13:28:19
maintainerNone
docs_urlNone
authorKtechHub
requires_python>=3.8.0
licenseMIT
keywords mtai mediatranscribe mtaiapi python library
VCS
bugtrack_url
requirements black pytest requests
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [mt-ai-python](#mt-ai-python)
  - [API SECRET KEY](#api-secret-key)
  - [Installation](#installation)
  - [Example](#example)
    - [Instantiate mtai](#instantiate-mtai)
    - [Static Use](#static-use)
    - [Resources](#resources)
    - [Contribution](#contribution)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# mt-ai-python
Python package for [MediaTranscribe](https://ai.mediatranscribe.com/) View on [pypi.python.org](https://pypi.org/project/mtai/)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://img.shields.io/badge/license-MIT-blue.svg)
[![PyPI version](https://badge.fury.io/py/mtai.svg)](https://badge.fury.io/py/mtai)

## API SECRET KEY
Get your secret key from [https://ai.mediatranscribe.com/](https://ai.mediatranscribe.com/)
## Installation
```sh
pip install mtai
```
## Example
### Instantiate mtai
```python
from mtai.mt import MT
secret_key = "secret_key_here"
mt = MT(secret_key=secret_key)

# use tag class
print(mt.tags.list()) # list tags
print(mt.tags.create_from_title(title="Python Programming Language")) # create tags
print(mt.tags.create_from_title_summary("Python", "Python is a programming language")) # create tags
print(mt.tags.get_tag_by_id("664e033837511b57fa93dd2e")) # get a tag
print(mt.tags.delete_tag_by_id("664e033837511b57fa93dd2e")) # delete a tag
```

### Static Use
To start using the MTAI Python API, you need to start by setting your secret key.

You can set your secret key in your environment by running:

```sh
export SECRET_KEY = 'your_secret_secret_key'
```

After exporting the keys, you can use the api like this
```python
# work with tags
from mtai.tags import Tag
print(Tag.list())
print(Tag.create_from_title(title="Python Programming Language"))
print(Tag.create_from_title_summary("Python", "Python is a programming language"))
print(Tag.get_tab_by_id("664e033837511b57fa93dd2e"))
print(Tag.delete_tag_by_id("664e033837511b57fa93dd2e"))
```

### Resources
```python
Transcription
Tag
Prompt
Bio
Description
```

Please reference the **[docs](https://github.com/mediatranscribe/mt-ai-python/tree/main/docs)** folder for usage.

### Contribution
If you want to join, kindly see this **[contribution](https://github.com/mediatranscribe/mt-ai-python/tree/main/contribution.md)**

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mediatranscribe/mt-ai-python",
    "name": "mtai",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8.0",
    "maintainer_email": null,
    "keywords": "mtai mediatranscribe mtaiapi python library",
    "author": "KtechHub",
    "author_email": "pypi@ktechhub.com",
    "download_url": "https://files.pythonhosted.org/packages/9a/4f/d8d66d0f462baebc1efeb071adec73ca877011ca9efceb5ab1be626b3561/mtai-0.1.0.tar.gz",
    "platform": null,
    "description": "\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*\n\n- [mt-ai-python](#mt-ai-python)\n  - [API SECRET KEY](#api-secret-key)\n  - [Installation](#installation)\n  - [Example](#example)\n    - [Instantiate mtai](#instantiate-mtai)\n    - [Static Use](#static-use)\n    - [Resources](#resources)\n    - [Contribution](#contribution)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n# mt-ai-python\nPython package for [MediaTranscribe](https://ai.mediatranscribe.com/) View on [pypi.python.org](https://pypi.org/project/mtai/)\n\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://img.shields.io/badge/license-MIT-blue.svg)\n[![PyPI version](https://badge.fury.io/py/mtai.svg)](https://badge.fury.io/py/mtai)\n\n## API SECRET KEY\nGet your secret key from [https://ai.mediatranscribe.com/](https://ai.mediatranscribe.com/)\n## Installation\n```sh\npip install mtai\n```\n## Example\n### Instantiate mtai\n```python\nfrom mtai.mt import MT\nsecret_key = \"secret_key_here\"\nmt = MT(secret_key=secret_key)\n\n# use tag class\nprint(mt.tags.list()) # list tags\nprint(mt.tags.create_from_title(title=\"Python Programming Language\")) # create tags\nprint(mt.tags.create_from_title_summary(\"Python\", \"Python is a programming language\")) # create tags\nprint(mt.tags.get_tag_by_id(\"664e033837511b57fa93dd2e\")) # get a tag\nprint(mt.tags.delete_tag_by_id(\"664e033837511b57fa93dd2e\")) # delete a tag\n```\n\n### Static Use\nTo start using the MTAI Python API, you need to start by setting your secret key.\n\nYou can set your secret key in your environment by running:\n\n```sh\nexport SECRET_KEY = 'your_secret_secret_key'\n```\n\nAfter exporting the keys, you can use the api like this\n```python\n# work with tags\nfrom mtai.tags import Tag\nprint(Tag.list())\nprint(Tag.create_from_title(title=\"Python Programming Language\"))\nprint(Tag.create_from_title_summary(\"Python\", \"Python is a programming language\"))\nprint(Tag.get_tab_by_id(\"664e033837511b57fa93dd2e\"))\nprint(Tag.delete_tag_by_id(\"664e033837511b57fa93dd2e\"))\n```\n\n### Resources\n```python\nTranscription\nTag\nPrompt\nBio\nDescription\n```\n\nPlease reference the **[docs](https://github.com/mediatranscribe/mt-ai-python/tree/main/docs)** folder for usage.\n\n### Contribution\nIf you want to join, kindly see this **[contribution](https://github.com/mediatranscribe/mt-ai-python/tree/main/contribution.md)**\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A python library to consume meditranscribe ai API",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/mediatranscribe/mt-ai-python"
    },
    "split_keywords": [
        "mtai",
        "mediatranscribe",
        "mtaiapi",
        "python",
        "library"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3260facc92a4de403ddd4ce970d00b895eba12817c9f06cd1621097c6b31fb57",
                "md5": "5ee88a744eb491418f2163d597c12ee7",
                "sha256": "e843e8b3bd78c8633c6e76f437ad2ee198d44608f378b42ffaec5893aa257bee"
            },
            "downloads": -1,
            "filename": "mtai-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5ee88a744eb491418f2163d597c12ee7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.0",
            "size": 7989,
            "upload_time": "2024-06-22T13:28:18",
            "upload_time_iso_8601": "2024-06-22T13:28:18.269108Z",
            "url": "https://files.pythonhosted.org/packages/32/60/facc92a4de403ddd4ce970d00b895eba12817c9f06cd1621097c6b31fb57/mtai-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9a4fd8d66d0f462baebc1efeb071adec73ca877011ca9efceb5ab1be626b3561",
                "md5": "3c392111ec4e3229cfcb528244fe07c4",
                "sha256": "dbdc88f6b052e44d3bf089e9c68e37fdb4c9133b545b8678569a7607bec0c1ea"
            },
            "downloads": -1,
            "filename": "mtai-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3c392111ec4e3229cfcb528244fe07c4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.0",
            "size": 7473,
            "upload_time": "2024-06-22T13:28:19",
            "upload_time_iso_8601": "2024-06-22T13:28:19.443970Z",
            "url": "https://files.pythonhosted.org/packages/9a/4f/d8d66d0f462baebc1efeb071adec73ca877011ca9efceb5ab1be626b3561/mtai-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-22 13:28:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mediatranscribe",
    "github_project": "mt-ai-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "black",
            "specs": []
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "requests",
            "specs": [
                [
                    "==",
                    "2.32.2"
                ]
            ]
        }
    ],
    "lcname": "mtai"
}
        
Elapsed time: 0.28466s