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 yiu 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.1.4.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: civitai_downloader-1.1.4.tar.gz
  • Upload date:
  • Size: 8.6 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.1.4.tar.gz
Algorithm Hash digest
SHA256 cd70e35ab5f5c6610ee46c3a5fc43116cf014b67b1bdf3a7f2ed2d3c78e24755
MD5 2641c7e1a401668054337914661f9648
BLAKE2b-256 ba27926f2aecf8b3a92b7a773a78b5ddf92bc8f1de8cf189749c275cebf915dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for civitai_downloader-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5a9f83018b902c64531d4b3ac5ab24ec7804b8597dfb059430ad648d91b3b63e
MD5 62757f5d3b72c2b1baffe0b2883a90d2
BLAKE2b-256 e7ec5305599bd49a7f8783680de1272731d6d625cb4567dea19942851e097c26

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