Skip to main content

A downloader for CivitAI models

Project description

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:

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:

civitai-downloader <url> <output_path> <token>

Programmatic Usage

You can also use the downloader in your own Python scripts.

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.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Credits

gradio demo by - Eddycrack864

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

civitai_downloader-1.2.5.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

civitai_downloader-1.2.5-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file civitai_downloader-1.2.5.tar.gz.

File metadata

  • Download URL: civitai_downloader-1.2.5.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for civitai_downloader-1.2.5.tar.gz
Algorithm Hash digest
SHA256 8f5b20abb90802a56fb0218b97dd182d9a6866e93e263eb6dfd1cdf813c5f150
MD5 1bd7f252f4296c6ffacb90de9ee799ed
BLAKE2b-256 993c0c336c2cf921d2c66ab6522a888dad6b10f30b16f301638cdaf3683757c8

See more details on using hashes here.

File details

Details for the file civitai_downloader-1.2.5-py3-none-any.whl.

File metadata

File hashes

Hashes for civitai_downloader-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e04bae665b369746e6308b01fcead08c97174ba4fd5c9b255d8cc1c0b99ef4cb
MD5 bddf4c4bfb10b5ad24352f0ecf2811ee
BLAKE2b-256 d415de86491f61ec933540eba602b3fc628fea547792b4f16d0f961c432f16ce

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page