<a name="readme-top"></a>
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
<br />
<h3 align="center">Astrotitles CLI</h3>
<p align="center">
Automatically generate subtitles using the Astrotitles command line interface.
<br />
<br />
<a href="https://astrotitles.com">View Web App</a>
·
<a href="https://github.com/Astrotitles/cli/issues">Report Bug</a>
·
<a href="https://github.com/Astrotitles/cli/issues">Request Feature</a>
</p>
</div>
## Getting Started
Astrotitles CLI is a tool that allows you to generate a srt/vtt subtitle file from a audio/video file. Astrotitles has word-level timestamps, allowing you to control how many characters are in each subtitle segment.
### Prerequisites
- Python: https://www.python.org/downloads/
### Installation
1. Install via pip
```sh
pip install astrotitles
```
2. Install via pip (github)
```sh
pip install git+https://github.com/Astrotitles/cli.git
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- USAGE EXAMPLES -->
## Usage
The Astrotitles CLI is self-documented with ```--help``` content and examples for every command. You should start exploring the CLI by using the global ```--help``` option:
```sh
astrotitles --help
```
```
usage: astrotitles [-h] [--output OUTPUT] [--output-name OUTPUT_NAME] [--max-chars MAX_CHARS]
[--format FORMAT] [--model MODEL] [--verbose VERBOSE] input
Generate a srt/vtt subtitle file from audio/video file
positional arguments:
input Input audio/video file to be transcribed
options:
-h, --help show this help message and exit
--output OUTPUT Specify output directory for srt/vtt subtitle file
--output-name OUTPUT_NAME
Specify output file name (no extension)
--max-chars MAX_CHARS
Specify the maximum number of characters allowed per subtitle segment
--format FORMAT Specify subtitle format (default: .srt)
--model MODEL Whisper AI model to use for transcribing
--verbose VERBOSE Print out progress of transcription process (default: True)
Thanks for using Astrotitles CLI!
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## License
Distributed under the AGPL-3.0 License. See `LICENSE.txt` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Contact
- [Ben Webster](https://benwebs.com)
- Project: [https://github.com/Astrotitles/cli](https://github.com/Astrotitles/cli)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
Thanks for using Astrotitles! 🔥
[contributors-shield]: https://img.shields.io/github/contributors/Astrotitles/cli.svg?style=for-the-badge
[contributors-url]: https://github.com/Astrotitles/cli/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Astrotitles/cli.svg?style=for-the-badge
[forks-url]: https://github.com/Astrotitles/cli/network/members
[stars-shield]: https://img.shields.io/github/stars/Astrotitles/cli.svg?style=for-the-badge
[stars-url]: https://github.com/Astrotitles/cli/stargazers
[issues-shield]: https://img.shields.io/github/issues/Astrotitles/cli.svg?style=for-the-badge
[issues-url]: https://github.com/Astrotitles/cli/issues
[license-shield]: https://img.shields.io/github/license/Astrotitles/cli.svg?style=for-the-badge
[license-url]: https://github.com/Astrotitles/cli/blob/master/LICENSE.txt
Raw data
{
"_id": null,
"home_page": "https://github.com/Astrotitles/cli",
"name": "astrotitles",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "AI,Whisper AI,Subtitles",
"author": "Ben Webster",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/3e/ee/61e35c93eb3441c64a6e7923c7bdc1befb932ec87db4197f61b82c866248/astrotitles-0.1.6.tar.gz",
"platform": null,
"description": "<a name=\"readme-top\"></a>\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n<br />\n\n<h3 align=\"center\">Astrotitles CLI</h3>\n\n <p align=\"center\">\n Automatically generate subtitles using the Astrotitles command line interface.\n <br />\n <br />\n <a href=\"https://astrotitles.com\">View Web App</a>\n \u00b7\n <a href=\"https://github.com/Astrotitles/cli/issues\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/Astrotitles/cli/issues\">Request Feature</a>\n </p>\n</div>\n\n## Getting Started\n\nAstrotitles CLI is a tool that allows you to generate a srt/vtt subtitle file from a audio/video file. Astrotitles has word-level timestamps, allowing you to control how many characters are in each subtitle segment.\n\n### Prerequisites\n\n- Python: https://www.python.org/downloads/\n\n### Installation\n\n1. Install via pip\n ```sh\n pip install astrotitles\n ```\n2. Install via pip (github)\n ```sh\n pip install git+https://github.com/Astrotitles/cli.git\n ```\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- USAGE EXAMPLES -->\n## Usage\n\nThe Astrotitles CLI is self-documented with ```--help``` content and examples for every command. You should start exploring the CLI by using the global ```--help``` option:\n\n```sh\nastrotitles --help\n```\n\n```\nusage: astrotitles [-h] [--output OUTPUT] [--output-name OUTPUT_NAME] [--max-chars MAX_CHARS] \n [--format FORMAT] [--model MODEL] [--verbose VERBOSE] input\n\nGenerate a srt/vtt subtitle file from audio/video file\n\npositional arguments:\n input Input audio/video file to be transcribed\n\noptions:\n -h, --help show this help message and exit\n --output OUTPUT Specify output directory for srt/vtt subtitle file\n --output-name OUTPUT_NAME\n Specify output file name (no extension)\n --max-chars MAX_CHARS\n Specify the maximum number of characters allowed per subtitle segment\n --format FORMAT Specify subtitle format (default: .srt)\n --model MODEL Whisper AI model to use for transcribing\n --verbose VERBOSE Print out progress of transcription process (default: True)\n\nThanks for using Astrotitles CLI!\n```\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n## License\n\nDistributed under the AGPL-3.0 License. See `LICENSE.txt` for more information.\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n## Contact\n\n- [Ben Webster](https://benwebs.com)\n- Project: [https://github.com/Astrotitles/cli](https://github.com/Astrotitles/cli)\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\nThanks for using Astrotitles! \ud83d\udd25\n\n[contributors-shield]: https://img.shields.io/github/contributors/Astrotitles/cli.svg?style=for-the-badge\n[contributors-url]: https://github.com/Astrotitles/cli/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/Astrotitles/cli.svg?style=for-the-badge\n[forks-url]: https://github.com/Astrotitles/cli/network/members\n[stars-shield]: https://img.shields.io/github/stars/Astrotitles/cli.svg?style=for-the-badge\n[stars-url]: https://github.com/Astrotitles/cli/stargazers\n[issues-shield]: https://img.shields.io/github/issues/Astrotitles/cli.svg?style=for-the-badge\n[issues-url]: https://github.com/Astrotitles/cli/issues\n[license-shield]: https://img.shields.io/github/license/Astrotitles/cli.svg?style=for-the-badge\n[license-url]: https://github.com/Astrotitles/cli/blob/master/LICENSE.txt\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Automatically generate subtitles using the Astrotitles command line interface.",
"version": "0.1.6",
"project_urls": {
"Download": "https://github.com/Astrotitles/cli.git",
"Homepage": "https://github.com/Astrotitles/cli"
},
"split_keywords": [
"ai",
"whisper ai",
"subtitles"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3eee61e35c93eb3441c64a6e7923c7bdc1befb932ec87db4197f61b82c866248",
"md5": "25464d2dd61419a91a566388c334b444",
"sha256": "5d0d3f92d815b2e7f1c364e6146c5f0b4f172133b774fb68402aaf99c64118af"
},
"downloads": -1,
"filename": "astrotitles-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "25464d2dd61419a91a566388c334b444",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16315,
"upload_time": "2023-07-21T21:33:30",
"upload_time_iso_8601": "2023-07-21T21:33:30.038549Z",
"url": "https://files.pythonhosted.org/packages/3e/ee/61e35c93eb3441c64a6e7923c7bdc1befb932ec87db4197f61b82c866248/astrotitles-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-21 21:33:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Astrotitles",
"github_project": "cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "astrotitles"
}
JSON
