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.3.5.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

civitai_downloader-1.3.5-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: civitai_downloader-1.3.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.3.5.tar.gz
Algorithm Hash digest
SHA256 b45249946ee1bd84cfb0bcef0e7cb4800926a1a9f3e61cf46360c8f720ca68bc
MD5 40438badb02b91f151a60299842b5216
BLAKE2b-256 e96eb1ae158c76843b313d9e16a54ce53057264ccbf6b34ea6f1f2aa2a197b47

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for civitai_downloader-1.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 aa7016117685a828c427a681eda8608c237163a07e07f782512b30955fe092d9
MD5 ce64a35b7c5599b28c583390f2887114
BLAKE2b-256 bbca484855d38f4dc6cda0540a99be22e994ab75d3f5a40ac12d68fe90485a31

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