Metadata-Version: 2.1
Name: wagtailmakeup
Version: 1.0.1
Summary: Wagtail Makeup
Home-page: https://github.com/kevinhowbrook/wagtail-makeup
Author: Kevin Howbrook
License: MIT
Keywords: wagtail,django
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.1
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 4
Classifier: Framework :: Wagtail :: 5
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: testing

# Wagtail Makeup

![tests](https://github.com/kevinhowbrook/wagtail-makeup/workflows/Tests/badge.svg)
[![codecov](https://codecov.io/gh/kevinhowbrook/wagtail-makeup/branch/main/graph/badge.svg?token=A4H7PFEL9J)](https://codecov.io/gh/kevinhowbrook/wagtail-makeup)

Tired of having no images locally when you need them? Don't want to fill your computer up with images?
Use Wagtail Makeup ;)

## Installation

Wagtail makeup depends on python unsplash:

```bash
pip install python-unsplash wagtailmakeup
```

## Configuration

Sign up for an Unsplash api key and add this to your settings:

```python
# settings.py
WAGTAIL_UNSPLASH = {
    "CLIENT_ID": "",
    "CLIENT_SECRET": ""
}
```

The API is rate limited to 50 request/hour... you can apply for a [higher rate limit](https://help.unsplash.com/en/articles/3887917-when-should-i-apply-for-a-higher-rate-limit).

## Using

You probably don't want this in your production settings, so add the following to you local.py settings:

```python
INSTALLED_APPS.append('wagtailmakeup')
```

Wagtail Makeup works by providing a new management command:

```bash
python manage.py make_up [search query] [amount of images]
```

So you want to replace all your broken images on your site with dogs (who wouldn't)
you can do it like this:

```python
python manage.py make_up dogs 10
```

Note: the amount value is the number of images to download, the higher this is, the more variance you will get 😎

## Contributing

Contributions are welcome, please see our [contributing guide](docs/CONTRIBUTING.md) for more details.
