Skip to main content

Yandex Disk remote storage plugin for DVC

Project description

dvc-yadisk

Yandex Disk remote storage plugin for DVC (Data Version Control).

Installation

# Using uv
uv add dvc-yadisk

# Using pip
pip install dvc-yadisk

After installation, enable the plugin:

# Run the enable script to register the plugin with DVC
dvc-yadisk-enable

This creates a sitecustomize.py file in your Python environment that loads the plugin automatically when DVC starts.

Configuration

1. Get Yandex Disk OAuth Token

  1. Go to Yandex Poginon
  2. Create a token
  3. Copy the token

2. Configure DVC Remote

# Add a Yandex Disk remote
dvc remote add -d myremote yadisk://my-dvc-data

# Set the OAuth token (use --local to avoid committing token to git)
dvc remote modify --local myremote token YOUR_OAUTH_TOKEN

Or use environment variable:

export YADISK_TOKEN=YOUR_OAUTH_TOKEN

3. Use DVC as Normal

# Track data
dvc add data/

# Push to Yandex Disk
dvc push

# Pull from Yandex Disk
dvc pull

Configuration Options

Option Environment Variable Description
token YADISK_TOKEN OAuth access token (required)

Example Usage

from dvc_yadisk import YaDiskFileSystem

# Create filesystem instance
fs = YaDiskFileSystem(token="your_oauth_token")

# List files
files = fs.ls("my-folder")

# Check if file exists
exists = fs.exists("my-folder/data.csv")

# Read file
data = fs.cat_file("my-folder/data.csv")

# Write file
fs.pipe_file("my-folder/output.txt", b"Hello, World!")

Async Usage

import asyncio
from dvc_yadisk import get_async_filesystem

async def main():
    AsyncFS = get_async_filesystem()
    fs = AsyncFS(token="your_oauth_token")

    # List files
    files = await fs.ls("my-folder")

    # Read file
    data = await fs.cat_file("my-folder/data.csv")

asyncio.run(main())

Limitations

  • Maximum file size: 1GB (50GB for Yandex 360 subscribers)
  • Upload URLs are valid for 30 minutes
  • API rate limits apply

Development

# Clone repository
git clone https://github.com/Suro4ek/dvc-yadisk.git
cd dvc-yadisk

# Install with dev dependencies
uv sync --dev

# Run tests
uv run pytest

# Run tests with coverage
uv run pytest --cov=dvc_yadisk

# Type checking
uv run mypy src/dvc_yadisk

# Linting
uv run ruff check src/dvc_yadisk

License

Apache License 2.0

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

dvc_yadisk-0.1.4.tar.gz (196.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dvc_yadisk-0.1.4-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file dvc_yadisk-0.1.4.tar.gz.

File metadata

  • Download URL: dvc_yadisk-0.1.4.tar.gz
  • Upload date:
  • Size: 196.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dvc_yadisk-0.1.4.tar.gz
Algorithm Hash digest
SHA256 a64367a7d142c830ae5313ba99fb531cff7911c804eec78137bdf0bdf379b807
MD5 2a7d902181ce0caaa57760eec5f762b2
BLAKE2b-256 0305440b2b4d58a85568df3baa27a6b7a14bbf9f2bf74ccc4cf6f93229df2b0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for dvc_yadisk-0.1.4.tar.gz:

Publisher: release.yml on Suro4ek/dvc-yadisk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dvc_yadisk-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: dvc_yadisk-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dvc_yadisk-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c787394318e98c1b9be9d8cb45af08c8ec19e08a94ee305e1f916dcdbe60eae8
MD5 5110d4e80bc368e25622a1037a071ff8
BLAKE2b-256 4c0cf3d0ce39a04a18643cddb2f0c1bbbe04866d1af627543cc84f0716badaf1

See more details on using hashes here.

Provenance

The following attestation bundles were made for dvc_yadisk-0.1.4-py3-none-any.whl:

Publisher: release.yml on Suro4ek/dvc-yadisk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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