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

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.

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

Uploaded Source

Built Distribution

civitai_downloader-0.1.2-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for civitai_downloader-0.1.2.tar.gz
Algorithm Hash digest
SHA256 572084d7d33cb7022d3bd7275c2ac8cbd8d69e3878e73fd65d8529f495ab788d
MD5 763ff0ec829effc016bda0e884fca27e
BLAKE2b-256 ab2164c2ca6bcc06c4d965cec9dcdb1efa921f8a1aeca37825cc3103185abfd2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for civitai_downloader-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a30090d78748beaa58de3b695e6cecacb47657f91e430f71a822fe8d17f6fb01
MD5 6820bae30bb52309dc635d7b7bb315ad
BLAKE2b-256 5f1829adabd3bf9bce88c8c9163f459a3b3dd2e921b00a5da8f27d35ee96aa58

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