wagtail-unsplashed


Namewagtail-unsplashed JSON
Version 1.0.11 PyPI version JSON
download
home_pageNone
SummaryUse unsplash.com images in your Wagtail site
upload_time2024-12-07 01:29:20
maintainerNone
docs_urlNone
authorNone
requires_python<4.0,>=3.9
licenseMIT License Copyright (c) 2019 Cameron Lamb Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # [Wagtail Unsplash](https://pypi.org/project/wagtail-unsplash/) [![PyPI](https://img.shields.io/pypi/v/wagtail-unsplash.svg)](https://pypi.org/project/wagtail-unsplash/)

[![Release](https://img.shields.io/github/v/release/mintyPT/wagtail-unsplash)](https://img.shields.io/github/v/release/mintyPT/wagtail-unsplash)
[![Build status](https://img.shields.io/github/actions/workflow/status/mintyPT/wagtail-unsplash/main.yml?branch=main)](https://github.com/mintyPT/wagtail-unsplash/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/mintyPT/wagtail-unsplash/branch/main/graph/badge.svg)](https://codecov.io/gh/mintyPT/wagtail-unsplash)
[![Commit activity](https://img.shields.io/github/commit-activity/m/mintyPT/wagtail-unsplash)](https://img.shields.io/github/commit-activity/m/mintyPT/wagtail-unsplash)
[![License](https://img.shields.io/github/license/mintyPT/wagtail-unsplash)](https://img.shields.io/github/license/mintyPT/wagtail-unsplash)

![Screenshot showing wagtail-unsplash search results](https://i.imgur.com/Va0kCys.png)

Search for Unsplash images and upload to the Wagtail image library.

This package uses the [python-unsplash](https://github.com/yakupadakli/python-unsplash) API wrapper

- **Github repository**: <https://github.com/mintyPT/wagtail-unsplash/>
- **Documentation** <https://mintyPT.github.io/wagtail-unsplash/>

## Getting started

Install using pip:

```sh
pip install wagtail-unsplashed
```

After installing the package, add `wagtail_unsplashed` to installed apps in your settings file:

```python
# settings.py

INSTALLED_APPS = [
    ...
    'wagtail_unsplashed',
    ...
]
```

and add the API credentials:

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

You can get the needed information by creating an application at https://unsplash.com/developers

## Getting started (development)

### Pull the repo

```bash
git clone git@github.com:mintyPT/wagtail-unsplash.git
```

### Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

```bash
make install
```

This will also generate your `uv.lock` file

### Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

```bash
uv run pre-commit run -a
```

### After pushing

You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).

## Releasing a new version

- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/mintyPT/wagtail-unsplash/settings/secrets/actions/new).
- Create a [new release](https://github.com/mintyPT/wagtail-unsplash/releases/new) on Github.
- Create a new tag in the form `*.*.*`.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "wagtail-unsplashed",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "python",
    "author": null,
    "author_email": "Cameron Lamb <jafacakes2011@hotmail.co.uk>, Mauro Santos <mauro.goncalo@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/d9/eb/71275c8e7d5e430c203e878e3d6f142f9f88804309b1347d64fa7ae64ab2/wagtail_unsplashed-1.0.11.tar.gz",
    "platform": null,
    "description": "# [Wagtail Unsplash](https://pypi.org/project/wagtail-unsplash/) [![PyPI](https://img.shields.io/pypi/v/wagtail-unsplash.svg)](https://pypi.org/project/wagtail-unsplash/)\n\n[![Release](https://img.shields.io/github/v/release/mintyPT/wagtail-unsplash)](https://img.shields.io/github/v/release/mintyPT/wagtail-unsplash)\n[![Build status](https://img.shields.io/github/actions/workflow/status/mintyPT/wagtail-unsplash/main.yml?branch=main)](https://github.com/mintyPT/wagtail-unsplash/actions/workflows/main.yml?query=branch%3Amain)\n[![codecov](https://codecov.io/gh/mintyPT/wagtail-unsplash/branch/main/graph/badge.svg)](https://codecov.io/gh/mintyPT/wagtail-unsplash)\n[![Commit activity](https://img.shields.io/github/commit-activity/m/mintyPT/wagtail-unsplash)](https://img.shields.io/github/commit-activity/m/mintyPT/wagtail-unsplash)\n[![License](https://img.shields.io/github/license/mintyPT/wagtail-unsplash)](https://img.shields.io/github/license/mintyPT/wagtail-unsplash)\n\n![Screenshot showing wagtail-unsplash search results](https://i.imgur.com/Va0kCys.png)\n\nSearch for Unsplash images and upload to the Wagtail image library.\n\nThis package uses the [python-unsplash](https://github.com/yakupadakli/python-unsplash) API wrapper\n\n- **Github repository**: <https://github.com/mintyPT/wagtail-unsplash/>\n- **Documentation** <https://mintyPT.github.io/wagtail-unsplash/>\n\n## Getting started\n\nInstall using pip:\n\n```sh\npip install wagtail-unsplashed\n```\n\nAfter installing the package, add `wagtail_unsplashed` to installed apps in your settings file:\n\n```python\n# settings.py\n\nINSTALLED_APPS = [\n    ...\n    'wagtail_unsplashed',\n    ...\n]\n```\n\nand add the API credentials:\n\n```python\n# settings.py\nWAGTAIL_UNSPLASHED = {\n    \"CLIENT_ID\": \"\",\n    \"CLIENT_SECRET\": \"\"\n}\n```\n\nYou can get the needed information by creating an application at https://unsplash.com/developers\n\n## Getting started (development)\n\n### Pull the repo\n\n```bash\ngit clone git@github.com:mintyPT/wagtail-unsplash.git\n```\n\n### Set Up Your Development Environment\n\nThen, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nThis will also generate your `uv.lock` file\n\n### Run the pre-commit hooks\n\nInitially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:\n\n```bash\nuv run pre-commit run -a\n```\n\n### After pushing\n\nYou are now ready to start development on your project!\nThe CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.\n\nTo finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).\n\n## Releasing a new version\n\n- Create an API Token on [PyPI](https://pypi.org/).\n- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/mintyPT/wagtail-unsplash/settings/secrets/actions/new).\n- Create a [new release](https://github.com/mintyPT/wagtail-unsplash/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n\nFor more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2019  Cameron Lamb  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Use unsplash.com images in your Wagtail site",
    "version": "1.0.11",
    "project_urls": {
        "Documentation": "https://mintyPT.github.io/wagtail-unsplashed/",
        "Homepage": "https://mintyPT.github.io/wagtail-unsplashed/",
        "Repository": "https://github.com/mintyPT/wagtail-unsplashed"
    },
    "split_keywords": [
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3aa206468131becf50bce9225c88472a52011b1d17b45ed329d8b98a7464f6cf",
                "md5": "59e2128ba4ee43b147cd354928d56656",
                "sha256": "85d9babf765621924b13ac1cf38a8b5e2fdc9c4b23ffc149143f162458b2fd65"
            },
            "downloads": -1,
            "filename": "wagtail_unsplashed-1.0.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "59e2128ba4ee43b147cd354928d56656",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 9069,
            "upload_time": "2024-12-07T01:29:18",
            "upload_time_iso_8601": "2024-12-07T01:29:18.780223Z",
            "url": "https://files.pythonhosted.org/packages/3a/a2/06468131becf50bce9225c88472a52011b1d17b45ed329d8b98a7464f6cf/wagtail_unsplashed-1.0.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d9eb71275c8e7d5e430c203e878e3d6f142f9f88804309b1347d64fa7ae64ab2",
                "md5": "356ffd655da6b93c26e5f55524035513",
                "sha256": "5d816774e97298de83ba351c082321bfde22e053020c787e2e696994e135f7a9"
            },
            "downloads": -1,
            "filename": "wagtail_unsplashed-1.0.11.tar.gz",
            "has_sig": false,
            "md5_digest": "356ffd655da6b93c26e5f55524035513",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 9458,
            "upload_time": "2024-12-07T01:29:20",
            "upload_time_iso_8601": "2024-12-07T01:29:20.220570Z",
            "url": "https://files.pythonhosted.org/packages/d9/eb/71275c8e7d5e430c203e878e3d6f142f9f88804309b1347d64fa7ae64ab2/wagtail_unsplashed-1.0.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-07 01:29:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mintyPT",
    "github_project": "wagtail-unsplashed",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "wagtail-unsplashed"
}
        
Elapsed time: 0.39667s