Metadata-Version: 2.4
Name: janim-url-assets
Version: 0.1.2
Summary: JAnim plugin for loading remote assets directly from URLs
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python
License-File: LICENSE
Requires-Dist: janim

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)
[![PyPI Latest Release](https://img.shields.io/pypi/v/janim-url-assets.svg?style=flat&logo=pypi)](https://pypi.org/project/janim-url-assets/)
[![en Documentation Status](https://readthedocs.org/projects/janim-url-assets-en/badge/?version=latest)](https://janim-url-assets.readthedocs.io/en/latest/)

<div align="center">

**> English <** | [简体中文](README_zh_CN.md)

</div>

## Introduction

`janim-url-assets` is a JAnim plugin for loading remote assets directly from URLs.

Main provided items are:

- `UrlSVGItem`: load an SVG from a URL and use it as a normal `SVGItem`
- `UrlImageItem`: load an image from a URL and use it as a normal `ImageItem`


## Installation

```bash
pip install janim-url-assets
```

After installation, examples from this plugin will appear in `janim examples`.

## Usage

### Import

```python
from janim_url_assets.imports import *
```

### Load SVG from URL

```python
UrlSVGItem('https://dev.w3.org/SVG/tools/svgweb/samples/svg-files/ibm.svg')
```

### Load image from URL

```python
UrlImageItem('https://raw.githubusercontent.com/jkjkil4/JAnim/main/assets/logo.png')
```

### Use resources from specific asset sites

```python
Iconify('skill-icons:aftereffects', width=1)
```

You can search icon names at <https://icon-sets.iconify.design/>.

