| Name | hlvox JSON |
| Version |
0.11.1
JSON |
| download |
| home_page | None |
| Summary | Pieces together voice files to form sentences |
| upload_time | 2025-07-12 01:49:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# HLVox
[](https://gitlab.com/bhagen/hlvox/commits/master)
[](https://gitlab.com/bhagen/hlvox/commits/master)
[](https://badge.fury.io/py/hlvox)
Originally intended to create sentences from the word snippets for the
Half Life 1 Vox, this project can take a folder of word audio files and piece
them into sentences.
This repo when used standalone (ie by running `voice.py` directly) will output
the sentences as audio files.
## Getting Started
To use this project, you will first need a folder full of voice files.
If you have Half Life 1 installed, the voices can be extracted from the VPK
files using something like GCFScape.
### Prerequisites
Check pipenv file for Python package requirements.
An installation of FFMpeg is required. On Ubuntu, just run the following:
```
apt update
apt install ffmpeg
```
For persistence, a local `sqlite` database can be used, or a `postgresql` database. These are not exposed through the basic CLI.
### Installing
How to set up a basic dev environment:
Pull this repo
```
git pull https://gitlab.com/bhagen/hlvox.git
```
Change into the new repo directory
```
cd hlvox
```
Install requirements using pipenv
```
pipenv install
```
Enter pipenv
```
pipenv shell
```
### Quick Start
If you want to jump right into generating a sentence, you can point `voice.py`
at a folder of voice audio files!
```
python hlvox/voice.py --voice-dir ~/my_folder_of_voice_files "the sentence I want to generate"
```
Your sentence will be exported in the same directory
that you ran the file from.
### Installing package locally for development
After entering pipenv shell:
```
pip install --editable .
```
## Running the tests
Just run `pytest` from the base directory of the repo
## Documentation Generation
I used [Sphinx](http://www.sphinx-doc.org) to create autodoc documentation
from docstrings in the modules.
Change into doc directory
```
cd doc
```
(If you've modified the source code, grab the new apidocs
```
sphinx-apidoc -f -o ./source ../hlvox
```
Generate documentation
```
make html
```
## Authors
* **Blair Hagen** - *Initial work* - [bhagen](https://github.com/bhagen)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Thanks to Valve for making such an amazing voice
Raw data
{
"_id": null,
"home_page": null,
"name": "hlvox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Blair Hagen <bhagen55@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3f/9f/2998ad7f29a3f32a6da8cf58ca37da863d6aa42d3faa4fbb682c7d772099/hlvox-0.11.1.tar.gz",
"platform": null,
"description": "# HLVox\n\n[](https://gitlab.com/bhagen/hlvox/commits/master)\n[](https://gitlab.com/bhagen/hlvox/commits/master)\n[](https://badge.fury.io/py/hlvox)\n\nOriginally intended to create sentences from the word snippets for the \nHalf Life 1 Vox, this project can take a folder of word audio files and piece \nthem into sentences.\nThis repo when used standalone (ie by running `voice.py` directly) will output\nthe sentences as audio files.\n\n## Getting Started\n\nTo use this project, you will first need a folder full of voice files.\nIf you have Half Life 1 installed, the voices can be extracted from the VPK \nfiles using something like GCFScape.\n\n### Prerequisites\n\nCheck pipenv file for Python package requirements.\n\nAn installation of FFMpeg is required. On Ubuntu, just run the following:\n\n```\napt update\napt install ffmpeg\n```\n\nFor persistence, a local `sqlite` database can be used, or a `postgresql` database. These are not exposed through the basic CLI.\n\n### Installing\n\nHow to set up a basic dev environment:\n\nPull this repo\n\n```\ngit pull https://gitlab.com/bhagen/hlvox.git\n```\n\nChange into the new repo directory\n\n```\ncd hlvox\n```\n\nInstall requirements using pipenv\n```\npipenv install \n```\n\nEnter pipenv\n```\npipenv shell\n```\n\n### Quick Start\n\nIf you want to jump right into generating a sentence, you can point `voice.py` \nat a folder of voice audio files!\n\n```\npython hlvox/voice.py --voice-dir ~/my_folder_of_voice_files \"the sentence I want to generate\"\n```\n\nYour sentence will be exported in the same directory\nthat you ran the file from.\n\n### Installing package locally for development\nAfter entering pipenv shell:\n```\npip install --editable .\n```\n\n## Running the tests\n\nJust run `pytest` from the base directory of the repo\n\n## Documentation Generation\n\nI used [Sphinx](http://www.sphinx-doc.org) to create autodoc documentation\nfrom docstrings in the modules.\n\nChange into doc directory\n```\ncd doc\n```\n\n(If you've modified the source code, grab the new apidocs\n```\nsphinx-apidoc -f -o ./source ../hlvox\n```\n\n\nGenerate documentation\n```\nmake html\n```\n\n\n## Authors\n\n* **Blair Hagen** - *Initial work* - [bhagen](https://github.com/bhagen)\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Acknowledgments\n\n* Thanks to Valve for making such an amazing voice\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pieces together voice files to form sentences",
"version": "0.11.1",
"project_urls": {
"Homepage": "https://gitlab.com/bhagen/hlvox"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2fda037e29c4ed8f84a761daaab3b14c085974fac9e7a9b8e09c83299ccef6d3",
"md5": "ec017a3f2d42a8ea7eb43b7770c817ea",
"sha256": "d76321bd171dec30c262f301d53c9680db4fc6ad14c0bcb3419995fe45d4a701"
},
"downloads": -1,
"filename": "hlvox-0.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec017a3f2d42a8ea7eb43b7770c817ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 17459,
"upload_time": "2025-07-12T01:49:57",
"upload_time_iso_8601": "2025-07-12T01:49:57.925293Z",
"url": "https://files.pythonhosted.org/packages/2f/da/037e29c4ed8f84a761daaab3b14c085974fac9e7a9b8e09c83299ccef6d3/hlvox-0.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f9f2998ad7f29a3f32a6da8cf58ca37da863d6aa42d3faa4fbb682c7d772099",
"md5": "29cf8a69b2982b6e7ef64230b11e5545",
"sha256": "5d028d752b0f2fd5c071d837caa25f4c867e7f8101fabca91589c23fe6ab278d"
},
"downloads": -1,
"filename": "hlvox-0.11.1.tar.gz",
"has_sig": false,
"md5_digest": "29cf8a69b2982b6e7ef64230b11e5545",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 77855,
"upload_time": "2025-07-12T01:49:59",
"upload_time_iso_8601": "2025-07-12T01:49:59.109870Z",
"url": "https://files.pythonhosted.org/packages/3f/9f/2998ad7f29a3f32a6da8cf58ca37da863d6aa42d3faa4fbb682c7d772099/hlvox-0.11.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-12 01:49:59",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "bhagen",
"gitlab_project": "hlvox",
"lcname": "hlvox"
}
