https://github.com/kylefox/placeholder-pics
Use Python to easily generate placeholder pictures for your users.
https://github.com/kylefox/placeholder-pics
Last synced: about 1 year ago
JSON representation
Use Python to easily generate placeholder pictures for your users.
- Host: GitHub
- URL: https://github.com/kylefox/placeholder-pics
- Owner: kylefox
- License: other
- Created: 2016-02-05T23:11:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-06-08T19:09:27.000Z (about 5 years ago)
- Last Synced: 2025-02-23T01:37:45.081Z (over 1 year ago)
- Language: Python
- Size: 76.2 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Placeholder Pics
Easily generate placeholder pictures for your users.
It's really good at rendering one or two letters inside a colored square, and terrible at everything else.
# Install
If you guessed pip, you are totally correct!
`pip install placeholder-pics`
# Basic Use
```python
from placeholder_pics import PlaceholderPic
placeholder = PlaceholderPic('KF')
placeholder.image.save('KF.png')
```
The `image` property is an instance of [`PIL.Image.Image`](http://pillow.readthedocs.org/en/3.0.x/reference/Image.html#the-image-class). This means you can save it however you like, or even apply additional manipulations. You could rotate it, for example, which would be kind of silly. Don't do that!
# Parameters
The only required parameter to `Placeholder` is the text you want to render.
The following optional parameters are accepted.
| Parameter | Default | Description |
| ------------- | ------------- | ------------- |
| `size` | `300` | Image dimensions (always square) |
| `foreground` | `"#ffffff"` | Text color (hex format, _with_ leading #) |
| `background` | `None` | Background color (hex format, _with_ leading #). If `None`, our algorithm (`random.choice`) will choose a nice [Material Design](https://www.google.com/design/spec/style/color.html#color-color-palette) color for you, no sweat. Pass `"random"` to generate a _totally_ random color. |
| `font_file` | `"SourceSansPro-Regular.ttf"` | File name of the font you'd like to use. [Source Sans Regular](https://www.google.com/fonts/specimen/Source+Sans+Pro) is included by default. See [`PIL.ImageFont`](http://pillow.readthedocs.org/en/3.0.x/reference/ImageFont.html) for more info on how fonts are loaded. |
| `font_size` | `None` | Font size, in points. If `None`, will default to `size/2`, which seems to be a decent proportion. |
# Are you SO mad because of bugs or missing features?!?!
Just kidding, you know what to do. [Submit an issue.](https://github.com/kylefox/placeholder-pics/issues)
# Font Credits
[Source Sans Pro](https://www.google.com/fonts/specimen/Source+Sans+Pro) was designed by [Paul D. Hunt](https://plus.google.com/108888178732927400671/about) and is distributed under the [SIL Open Font License, 1.1.](http://scripts.sil.org/OFL)
# License (MIT)
Placeholder Pics is distributed under the MIT License.
Learn more at http://opensource.org/licenses/mit-license.php
Copyright (c) 2016 Kyle Fox
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.