search

daswer123 / xtts-api-server

A simple FastAPI Server to run XTTSv2
MIT License
372 stars 85 forks source link

Adds Simple Userfriendly Launcher #66

Closed deffcolony closed 6 months ago

deffcolony commented 6 months ago

Pull Request: A Simple Userfriendly Launcher

Description

This pull request introduces several features to the XTTS launcher script, made in batch script for CMD providing a more user-friendly and automated experience. The primary features include:

  1. Automated Installation Process

    • The script automatically installs requirements to make XTTS work.
    • Miniconda3 will be automatically installed + creating an isolated conda environment.
    • Python will be installed within the created conda environment.
    • Users will be asked if the script should create a shortcut on their desktop after installation to simply launch the menu again to run XTTS

  2. Easy management

    • Users can simply choose the update function so the launcher checks for the pip xtts updates
    • Users can simply uninstall the whole installation if they no longer want to use it
    • Users can edit XTTS modules so it adds start command flags and builds the launch

  3. User-Friendly Menu

    • A user-friendly menu is implemented, allowing users to choose various actions.
    • Options include installation, running the XTTS, updating, module editor, uninstalling, and exiting the menu.

Usage

Users can interact with the script by simply running launcher.bat and selecting options from the displayed menu. The script handles the installation, configuration, and uninstall of the XTTS

Testing

The script has been tested to ensure a smooth installation, proper configuration, and uninstallation. User input handling and automated actions have been thoroughly tested to provide a reliable and user-friendly experience.

Additional Notes

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The recent updates focus on refining the XTTS (Text-to-Speech) system's setup and operational efficiency. Key modifications include enhancing the .gitignore to better manage file tracking and streamlining the launcher.bat script for easier installation and maintenance of the XTTS system. These changes aim to simplify the user experience, from initial setup to daily use, ensuring that the system remains both functional and user-friendly.

Changes

File(s) Change Summary
.gitignore Updated to include modules-xtts.txt and remove .../coqui_engine_old.py.
launcher.bat Enhanced to automate setup, manage dependencies, and provide a user interface.

🐇✨
In the realm of code, where the rabbits dwell,
A whisper of change, through the burrow, it fell.
"Gather 'round, for the script is refined,
No more clutter, only ease you'll find.
Let's hop to the rhythm of the keystrokes' chime,
For in our digital burrow, it's always prime!"
🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.