# CivitAI Downloader
A Python package for downloading models from CivitAI via a command-line tool or programmatically. This package supports token-based authentication and allows users to save downloaded models to a specified directory.
## Installation
Install the package via pip:
```bash
pip install civitai-downloader
```
## Usage
## Gradio webui Usage
to run with gradio webui you can just run by this command
```
civitai-downloader
```
### Command-Line Usage
To download a model from CivitAI, use the `civitai-downloader` command with the following arguments:
```bash
civitai-downloader <url> <output_path> <token>
```
### Programmatic Usage
You can also use the downloader in your own Python scripts.
```python
from civitai_downloader import download_file, get_token, store_token
url = 'https://civitai.com/api/download/models/46846'
output_path = '/path/to/save'
token = 'your_api_token_here'
download_file(url, output_path, token)
```
## Features
- **Token-based authentication:** Automatically stores your CivitAI API token for future use.
- **Progress tracking:** Shows download progress with speed in MB/s.
- **Error handling:** Includes handling for common download errors like redirects and missing files.
## API Token
The first time you use `civitai_downloader`, you'll be prompted to enter your CivitAI API token. This token will be stored in `~/.civitai/config`. You can generate your API token from your [CivitAI account settings](https://civitai.com/settings).
## License
This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
## Credits
gradio demo by - [Eddycrack864](https://github.com/Eddycrack864)
Raw data
{
"_id": null,
"home_page": "https://github.com/Ryouko-Yamanda65777/civitai-downloader",
"name": "civitai-downloader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CivitAI downloader gradio",
"author": "Ryouko-Yamanda65777",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e9/6e/b1ae158c76843b313d9e16a54ce53057264ccbf6b34ea6f1f2aa2a197b47/civitai_downloader-1.3.5.tar.gz",
"platform": null,
"description": "# CivitAI Downloader\n\nA Python package for downloading models from CivitAI via a command-line tool or programmatically. This package supports token-based authentication and allows users to save downloaded models to a specified directory.\n\n\n\n\n\n\n## Installation\n\nInstall the package via pip:\n\n```bash\npip install civitai-downloader\n```\n\n## Usage\n\n\n## Gradio webui Usage\n\nto run with gradio webui you can just run by this command \n```\ncivitai-downloader\n```\n\n\n### Command-Line Usage\n\nTo download a model from CivitAI, use the `civitai-downloader` command with the following arguments:\n\n```bash\ncivitai-downloader <url> <output_path> <token>\n```\n\n\n\n### Programmatic Usage\n\nYou can also use the downloader in your own Python scripts.\n\n```python\nfrom civitai_downloader import download_file, get_token, store_token\n\nurl = 'https://civitai.com/api/download/models/46846'\noutput_path = '/path/to/save'\ntoken = 'your_api_token_here'\n\ndownload_file(url, output_path, token)\n```\n\n## Features\n\n- **Token-based authentication:** Automatically stores your CivitAI API token for future use.\n- **Progress tracking:** Shows download progress with speed in MB/s.\n- **Error handling:** Includes handling for common download errors like redirects and missing files.\n\n## API Token\n\nThe first time you use `civitai_downloader`, you'll be prompted to enter your CivitAI API token. This token will be stored in `~/.civitai/config`. You can generate your API token from your [CivitAI account settings](https://civitai.com/settings).\n\n## License\n\nThis project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.\n\n## Credits\n\ngradio demo by - [Eddycrack864](https://github.com/Eddycrack864)\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A downloader for CivitAI models",
"version": "1.3.5",
"project_urls": {
"Bug Tracker": "https://github.com/Ryouko-Yamanda65777/civitai-downloader/issues",
"Homepage": "https://github.com/Ryouko-Yamanda65777/civitai-downloader",
"Source Code": "https://github.com/Ryouko-Yamanda65777/civitai-downloader"
},
"split_keywords": [
"civitai",
"downloader",
"gradio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbca484855d38f4dc6cda0540a99be22e994ab75d3f5a40ac12d68fe90485a31",
"md5": "ce64a35b7c5599b28c583390f2887114",
"sha256": "aa7016117685a828c427a681eda8608c237163a07e07f782512b30955fe092d9"
},
"downloads": -1,
"filename": "civitai_downloader-1.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ce64a35b7c5599b28c583390f2887114",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 10425,
"upload_time": "2024-11-13T10:05:42",
"upload_time_iso_8601": "2024-11-13T10:05:42.115592Z",
"url": "https://files.pythonhosted.org/packages/bb/ca/484855d38f4dc6cda0540a99be22e994ab75d3f5a40ac12d68fe90485a31/civitai_downloader-1.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e96eb1ae158c76843b313d9e16a54ce53057264ccbf6b34ea6f1f2aa2a197b47",
"md5": "40438badb02b91f151a60299842b5216",
"sha256": "b45249946ee1bd84cfb0bcef0e7cb4800926a1a9f3e61cf46360c8f720ca68bc"
},
"downloads": -1,
"filename": "civitai_downloader-1.3.5.tar.gz",
"has_sig": false,
"md5_digest": "40438badb02b91f151a60299842b5216",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8663,
"upload_time": "2024-11-13T10:05:43",
"upload_time_iso_8601": "2024-11-13T10:05:43.031150Z",
"url": "https://files.pythonhosted.org/packages/e9/6e/b1ae158c76843b313d9e16a54ce53057264ccbf6b34ea6f1f2aa2a197b47/civitai_downloader-1.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 10:05:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ryouko-Yamanda65777",
"github_project": "civitai-downloader",
"github_not_found": true,
"lcname": "civitai-downloader"
}
JSON
