{"id":22372444,"url":"https://github.com/philipinho/threadvoice","last_synced_at":"2025-03-26T17:18:35.935Z","repository":{"id":265433734,"uuid":"584216278","full_name":"Philipinho/ThreadVoice","owner":"Philipinho","description":"Source code for https://twitter.com/threadvoice","archived":false,"fork":false,"pushed_at":"2023-03-18T20:07:17.000Z","size":51,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T06:35:59.347Z","etag":null,"topics":["java","text-to-speech","threadreader","tts","tts-api","tts-engines","twitter-api","twitter-bot"],"latest_commit_sha":null,"homepage":"https://threadvoice.net","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Philipinho.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-01T21:40:04.000Z","updated_at":"2023-03-18T20:28:03.000Z","dependencies_parsed_at":"2024-11-29T21:45:21.114Z","dependency_job_id":null,"html_url":"https://github.com/Philipinho/ThreadVoice","commit_stats":null,"previous_names":["philipinho/threadvoice"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Philipinho%2FThreadVoice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Philipinho%2FThreadVoice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Philipinho%2FThreadVoice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Philipinho%2FThreadVoice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Philipinho","download_url":"https://codeload.github.com/Philipinho/ThreadVoice/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245699259,"owners_count":20657987,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","text-to-speech","threadreader","tts","tts-api","tts-engines","twitter-api","twitter-bot"],"created_at":"2024-12-04T20:38:51.839Z","updated_at":"2025-03-26T17:18:35.899Z","avatar_url":"https://github.com/Philipinho.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ThreadVoice\n\nThreadVoice is a Twitter bot that turns Twitter threads into listenable audio podcasts. The Text-to-Speech engine is powered by Google, Microsoft, Amazon and VoiceRSS.\n\n## Setup\n\nMake sure to install the Java JDK, Maven and MYSQL on your server if you don't have them already.  \n\nIf you are on Ubuntu, run the following codes to install Java, Maven and MYSQL.\n\n```\nsudo apt update -y\nsudo apt install default-jdk -y\nsudo apt install maven -y\nsudo apt install mysql-server -y\n```\n\nReplace `src/main/resources/settings.properties.example` with `src/main/resources/settings.properties`.  \n`cp src/main/resources/settings.properties.example src/main/resources/settings.properties`    \n\nReplace `src/main/resources/gcloudkey.json.example` with `src/main/resources/gcloudkey.json`.  \n`cp src/main/resources/gcloudkey.json.example src/main/resources/gcloudkey.json`  \n\nCredential settings are stored inside the `src/main/resources/settings.properties` file.\nEdit the `settings.properties` file.  \n\n### Storage location of audio files\nThe `voice.path` is the location where the audio files are stored on the server. The default is set to `/var/www/html/audio/` which is inside the apache public `www/html/` directory for access on port 80.\n`voice.path=`\n\n### MYSQL\nSetup your MYSQL server and create a database named `threadvoice`.  \nImport the `src/main/resources/schema.sql` SQL file to create the appropriate database tables on your MYSQL server.  \n\nReplace `user=root\u0026password=12345` under the `mysql.db` properties with your correct MYSQL username and password.  \n\n### Twitter API Keys\n\nReplace the value of `twitter.username=` property with your Twitter bot username. Make sure to include the `@` before it,\n\nReplace the value of the following properties with your Twitter Developer API credentials (https://developer.twitter.com/en)\n```\ntw.apiKey=\ntw.apiSecretKey=\ntw.accessToken=\ntw.accessTokenSecret=\n```\n\n### TTS API Engine Setup\n\n#### Gcloud\nTo setup Google Cloud Text To Speech, create a Google Cloud Text to Speech project. Follow the instructions here generate your GCloud API credentials json file https://cloud.google.com/docs/authentication/getting-started#create-service-account-console.  \nCopy the contents of the generated GCloud json file and insert it inside the `src/main/resources/gcloudkey.json` file. Overwrite the existing file contents with it.  \nGoogle Cloud Text-to-Speech: https://cloud.google.com/text-to-speech\n\n#### Amazon Polly Keys\nReplace the value of below properties with your own Amazon Polly API keys.  \n```\naws.accesskey=\naws.secretkey=\n```\nAmazon Polly: https://aws.amazon.com/polly\n\n#### Microsoft Text\nReplace the value of below property with your own Microsoft TTS API key.  \n`microsoft.key=`  \n\nMicrosoft Text To Speech: https://azure.microsoft.com/en-us/services/cognitive-services/text-to-speech/  \n\n#### Microsoft Text\nReplace the value of below property with your own VoiceRSS API key.  \n`voicerss.key=` \n\nVoiceRSS: https://www.voicerss.org/  \n\n#### To install the VoiceRSS library\nThe VoiceRSS Java library is not available on maven central. The jar file is stored inside the `libs` folder.  \nExecute the below code on the main directory of this project.  \n\n```\n    mvn install:install-file \\\n   -Dfile=libs/voicerss_tts.jar \\\n   -DgroupId=com.voicerss.tts \\\n   -DartifactId=voicerss \\\n   -Dversion=1.0 \\\n   -Dpackaging=jar \\\n   -DgeneratePom=true\n```\n\n#### To build and compile the program\n`mvn clean install`\n\nAfter a successful build, you can now start the program with:  \n`java -jar target/threadvoice-2.0-SNAPSHOT.jar`  \nUse `nohup` to keep the program running even after the terminal is closed:  \n`nohup java -jar target/threadvoice-2.0-SNAPSHOT.jar \u0026`  \n\n\n#### TTS Limits\nEach Text-To-Speech provider have their character limit per request.\n\n| Provider  | Character Limits               |\n|:----------|:-------------------------------|\n| Google    | 5000                           |\n| Amazon    | 3000                           |\n| Microsoft | 10000; max audio is 10 minutes |\n| Voice RSS | 100KB                          |\n\n## LICENSE\nMIT License\n\nCopyright (c) 2023 Philip Okugbe\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilipinho%2Fthreadvoice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphilipinho%2Fthreadvoice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilipinho%2Fthreadvoice/lists"}