Metadata-Version: 2.1
Name: imgix
Version: 3.1.2
Summary: Python client library for imgix.
Home-page: https://github.com/imgix/imgix-python
Author: imgix
Author-email: support@imgix.com
License: BSD-2-Clause
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Requires-Dist: future
Provides-Extra: dev
Requires-Dist: tox ; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: flake8 ; extra == 'test'

<!-- ix-docs-ignore -->
![imgix logo](https://assets.imgix.net/sdk-imgix-logo.svg)

`imgix-python` is a client library for generating image URLs with [imgix](https://www.imgix.com/).

[![Version](https://img.shields.io/pypi/v/imgix.svg)](https://pypi.org/project/imgix/)
[![Build Status](https://travis-ci.org/imgix/imgix-python.svg?branch=master)](https://travis-ci.org/imgix/imgix-python)
![Downloads](https://img.shields.io/pypi/dm/imgix)
![Python Versions](https://img.shields.io/pypi/pyversions/imgix)
[![License](https://img.shields.io/github/license/imgix/imgix-python)](https://github.com/imgix/imgix-python/blob/master/LICENSE)

---
<!-- /ix-docs-ignore -->

- [Installation](#installation)
- [Usage](#usage)
  - [Signed URLs](#signed-urls)
  - [Srcset Generation](#srcset-generation)
  - [Usage with UTF-8](#usage-with-utf-8)
- [Testing](#testing)

## Installation

``` bash
pip install imgix
```

## Usage

To begin creating imgix URLs programmatically, import the imgix
library and create a URL builder. The URL builder can be reused to
create URLs for any images on the domains it is provided.

``` python
import imgix

builder = imgix.UrlBuilder("demos.imgix.net")
print builder.create_url("/bridge.png", {'w': 100, 'h': 100})

# Prints out:
# http://demos.imgix.net/bridge.png?h=100&w=100
```

For HTTPS support, specify the HTTPS flag like so:

``` python
import imgix

builder = imgix.UrlBuilder("demos.imgix.net", use_https=True)
print builder.create_url("/bridge.png", {'w': 100, 'h': 100})

# Prints out:
# https://demos.imgix.net/bridge.png?h=100&w=100
```

### Signed URLs

To produce a signed URL, you must enable secure URLs on your source and
then provide your signature key to the URL builder.

``` python
import imgix

builder = imgix.UrlBuilder("demos.imgix.net", sign_key="test1234")
print builder.create_url("/bridge.png", {'w': 100, 'h': 100})

# Prints out:
# http://demos.imgix.net/bridge.png?h=100&w=100&s=7370d6e36bb2262e73b19578739af1af
```

### Srcset Generation

The imgix-python package allows for generation of custom srcset
attributes, which can be invoked through `create_srcset()`. By default,
the srcset generated will allow for responsive size switching by
building a list of image-width mappings.

``` python
builder = imgix.UrlBuilder("demos.imgix.net", sign_key="my-token", include_library_param=False)
srcset = builder.create_srcset("image.png")
print srcset
```

Will produce the following attribute value, which can then be served to
the client:

``` html
https://demos.imgix.net/image.png?w=100&s=e415797545a77a9d2842dedcfe539c9a 100w,
https://demos.imgix.net/image.png?w=116&s=b2da46f5c23ef13d5da30f0a4545f33f 116w,
https://demos.imgix.net/image.png?w=134&s=b61422dead929f893c04b8ff839bb088 134w,
                                        ...
https://demos.imgix.net/image.png?w=7400&s=ad671301ed4663c3ce6e84cb646acb96 7400w,
https://demos.imgix.net/image.png?w=8192&s=a0fed46e2bbcc70ded13dc629aee5398 8192w
```

In cases where enough information is provided about an image\'s
dimensions, `create_srcset()` will instead build a srcset that will
allow for an image to be served at different resolutions. The parameters
taken into consideration when determining if an image is fixed-width are
`w`, `h`, and `ar`. By invoking `create_srcset()` with either a width
**or** the height and aspect ratio (along with `fit=crop`, typically)
provided, a different srcset will be generated for a fixed-size image
instead.

``` python
builder = imgix.UrlBuilder("demos.imgix.net", sign_key="my-token", include_library_param=False)
srcset = builder.create_srcset("image.png", {'h':800, 'ar':'3:2', 'fit':'crop'})
print srcset
```

Will produce the following attribute value:

``` html
https://demos.imgix.net/image.png?ar=3%3A2&dpr=1&fit=crop&h=800&s=6cf5c443d1eb98bc3d96ea569fcef088 1x,
https://demos.imgix.net/image.png?ar=3%3A2&dpr=2&fit=crop&h=800&s=d60a61a5f34545922bd8dff4e53a0555 2x,
https://demos.imgix.net/image.png?ar=3%3A2&dpr=3&fit=crop&h=800&s=590f96aa426f8589eb7e449ebbeb66e7 3x,
https://demos.imgix.net/image.png?ar=3%3A2&dpr=4&fit=crop&h=800&s=c89c2fd3148957647e86cfc32ba20517 4x,
https://demos.imgix.net/image.png?ar=3%3A2&dpr=5&fit=crop&h=800&s=3d73af69d78d49eef0f81b4b5d718a2c 5x
```

For more information to better understand srcset, we highly recommend
[Eric Portis\' \"Srcset and sizes\"
article](https://ericportis.com/posts/2014/srcset-sizes/) which goes
into depth about the subject.

### Usage with UTF-8

For usage with non-ASCII characters, please be sure to that your
project's source files specify UTF-8 encoding:

``` python
# -*- coding: utf-8 -*-
```

If you don\'t add this encoding, and you have an image with name for
example \'tiburón.jpeg\', you will get the following error trying to run
your script:

``` python
SyntaxError: Non-ASCII character '***' in file test.py on line 6, but no encoding declared; see http://www.python.org/peps/pep-0263.html for details
```

## Testing

Run the following to execute the project's tests and code linter:

``` bash
tox
```


Changelog
=========

[3.1.2](https://github.com/imgix/imgix-python/compare/3.1.1...3.1.2) (2019-03-11)
---------------------------------------------------------------------------------

- Fix Python 2/3 compatibility issues
    ([\#57](https://github.com/imgix/imgix-python/pull/57))

[3.1.1](https://github.com/imgix/imgix-python/compare/3.1.0...3.1.1) (2019-08-22)
---------------------------------------------------------------------------------

-   fix: include dpr parameter when generating fixed-width srcset
    ([\#50](https://github.com/imgix/imgix-python/pull/50))

[3.1.0](https://github.com/imgix/imgix-python/compare/3.0.0...3.1.0) (2019-08-22)
---------------------------------------------------------------------------------

-   feat: add srcset generation
    ([\#48](https://github.com/imgix/imgix-python/pull/48))
-   build(tox): improve code coverage reporting; parallelize testing
    ([\#49](https://github.com/imgix/imgix-python/pull/49))

[3.0.0](https://github.com/imgix/imgix-python/compare/2.3.0...3.0.0) (2019-06-07)
---------------------------------------------------------------------------------

-   fix: remove deprecated domain sharding functionality
    ([\#44](https://github.com/imgix/imgix-python/pull/44))
-   fix: remove deprecated [opts]{.title-ref} parameter
    ([\#46](https://github.com/imgix/imgix-python/pull/46))
-   fix: remove deprecated [sign\_with\_library\_version]{.title-ref}
    parameter ([\#47](https://github.com/imgix/imgix-python/pull/47))

[2.3.0](https://github.com/imgix/imgix-python/compare/2.2.0...2.3.0) (2019-06-06)
---------------------------------------------------------------------------------

-   feat: deprecate [domains]{.title-ref} in favor of
    [domain]{.title-ref}
    ([\#45](https://github.com/imgix/imgix-python/pull/45))

[2.2.0](https://github.com/imgix/imgix-python/compare/2.1.0...2.2.0) (2019-05-07)
---------------------------------------------------------------------------------

-   deprecate domain sharding
    ([\#41](https://github.com/imgix/imgix-python/pull/41))([\#42](https://github.com/imgix/imgix-python/pull/42))

2.1.0 (2019-02-13)
------------------

-   Domain validation added during [UrlBuilder]{.title-ref}
    initialization
-   [sign\_with\_library\_version]{.title-ref} parameter from
    [UrlBuilder]{.title-ref} deprecated in favor of
    [include\_library\_param]{.title-ref}.

2.0.0 (2018-08-08)
------------------

-   [UrlBuilder]{.title-ref}\'s [sign\_mode]{.title-ref} argument
    removed
-   [opts]{.title-ref} parameter from
    [UrlBuilder.create\_url]{.title-ref} deprecated in favor of
    [params]{.title-ref}.

1.2.0 (2018-06-20)
------------------

-   [sign\_mode]{.title-ref} argument deprecated
-   License corrected to BSD-2-Clause.
-   Docstrings added to classes and methods.

1.1.2 (2016-06-30)
------------------

-   Proper encodeURIComponent-style URL encoding for web proxy sources.
    See \#21 for more information.

1.1.0 (2016-02-26)
------------------

-   Added automatic Base64 encoding for all Base64 variant parameters.
-   Properly encoding all query keys and values.

1.0.0 (2016-01-15)
------------------

-   Change UrlBuilder\#create\_url to accept dict instead of kwargs.
    This fixes an issue with reserved words that are also imgix params
    potentially causing errors.

0.2.1 (2016-01-15)
------------------

-   Fixed a bug where any passed params that were falsy would not be
    passed through to imgix.

0.2.0 (2015-06-15)
------------------

-   Introduces defaulting to HTTPS on all requests, per the
    imgix-blueprint.

0.1.0 (2015-06-11)
------------------

-   Includes new functionality to sign every URL with an ixlib parameter
    for diagnostic purposes.

0.0.4 (2015-06-10)
------------------

-   New README note about publishing packages


