fotolab


Namefotolab JSON
Version 0.14.0 PyPI version JSON
download
home_pageNone
SummaryA console program that manipulate images.
upload_time2024-04-27 16:23:58
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseNone
keywords photography photo
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # fotolab

A console program to manipulate photos.

## Installation

Stable version From PyPI using `pipx`:

```console
pipx install fotolab
```

Stable version From PyPI using `pip`:

```console
python -m pip install fotolab
```

Upgrade to latest stable version:

```console
python3 -m pip install fotolab --upgrade
```

Latest development version from GitHub:

```console
python -m pip install -e git+https://github.com/kianmeng/fotolab.git
```

## Usage

```console
fotolab -h
```

```console

usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-d] [-V]
               {animate,auto,border,contrast,info,resize,montage,sharpen,watermark,env}
               ...

A console program to manipulate photos.

  website: https://github.com/kianmeng/fotolab
  changelog: https://github.com/kianmeng/fotolab/blob/master/CHANGELOG.md
  issues: https://github.com/kianmeng/fotolab/issues

positional arguments:
  {animate,auto,border,contrast,info,resize,montage,sharpen,watermark,env}
                    sub-command help
    animate         animate an image
    auto            auto adjust (resize, contrast, and watermark) a photo
    border          add border to image
    contrast        contrast an image
    info            info an image
    resize          resize an image
    montage         montage a list of image
    sharpen         sharpen an image
    watermark       watermark an image
    env             print environment information for bug reporting

optional arguments:
  -h, --help        show this help message and exit
  -o, --overwrite   overwrite existing image
  -op, --open       open the image using default program (default: 'False')
  -od OUTPUT_DIR, --output-dir OUTPUT_DIR
                    set default output folder (default: 'output')
  -q, --quiet       suppress all logging
  -d, --debug       show debugging log and stacktrace
  -V, --version     show program's version number and exit
```

### fotolab animate

```console
fotolab animate -h
```

```console

usage: fotolab animate [-h] [-f FORMAT] [-d DURATION] [-l LOOP]
                       IMAGE_FILENAMES [IMAGE_FILENAMES ...]

positional arguments:
  IMAGE_FILENAMES       set the image filenames

optional arguments:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        set the image format (default: 'gif')
  -d DURATION, --duration DURATION
                        set the duration in milliseconds (default: '2500')
  -l LOOP, --loop LOOP  set the loop cycle (default: '0')
```

### fotolab auto

```console
fotolab auto -h
```

```console
usage: fotolab auto [-h] IMAGE_FILENAMES [IMAGE_FILENAMES ...]

positional arguments:
  IMAGE_FILENAMES  set the image filename

optional arguments:
  -h, --help       show this help message and exit
```

### fotolab border

```console
fotolab border -h
```

```console
usage: fotolab border [-h] [-c COLOR] [-w WIDTH] [-wt WIDTH] [-wr WIDTH]
                      [-wb WIDTH] [-wl WIDTH]
                      IMAGE_FILENAMES [IMAGE_FILENAMES ...]

positional arguments:
  IMAGE_FILENAMES       set the image filenames

optional arguments:
  -h, --help            show this help message and exit
  -c COLOR, --color COLOR
                        set the color of border (default: 'black')
  -w WIDTH, --width WIDTH
                        set the width of border (default: '10')
  -wt WIDTH, --width-top WIDTH
                        set the width of top border (default: '0')
  -wr WIDTH, --width-right WIDTH
                        set the width of right border (default: '0')
  -wb WIDTH, --width-bottom WIDTH
                        set the width of bottom border (default: '0')
  -wl WIDTH, --width-left WIDTH
                        set the width of left border (default: '0')
```

### fotolab contrast

```console
fotolab contrast -h
```

```console
usage: fotolab contrast [-h] [-c CUTOFF] IMAGE_FILENAMES [IMAGE_FILENAMES ...]

positional arguments:
  IMAGE_FILENAMES       set the image filename

optional arguments:
  -h, --help            show this help message and exit
  -c CUTOFF, --cutoff CUTOFF
                        set the percentage of lightest or darkest pixels to
                        discard from histogram (default: '1')
```

### fotolab info

```console
fotolab info -h
```

```console
usage: fotolab info [-h] IMAGE_FILENAME

positional arguments:
  IMAGE_FILENAME  set the image filename

optional arguments:
  -h, --help      show this help message and exit
```

### fotolab montage

```console
fotolab montage -h
```

```console

usage: fotolab montage [-h] IMAGE_FILENAMES [IMAGE_FILENAMES ...]

positional arguments:
  IMAGE_FILENAMES  set the image filenames

optional arguments:
  -h, --help       show this help message and exit
```

### fotolab resize

```console
fotolab resize -h
```

```console
usage: fotolab resize [-h] [-wh WIDTH] [-ht HEIGHT]
                      IMAGE_FILENAMES [IMAGE_FILENAMES ...]

positional arguments:
  IMAGE_FILENAMES       set the image filename

optional arguments:
  -h, --help            show this help message and exit
  -wh WIDTH, --width WIDTH
                        set the width of the image (default: '600')
  -ht HEIGHT, --height HEIGHT
                        set the height of the image (default: '277')
```

### fotolab sharpen

```console
fotolab sharpen -h
```

```console
usage: fotolab sharpen [-h] [-r RADIUS] [-p PERCENT] [-t THRESHOLD]
                       IMAGE_FILENAMES [IMAGE_FILENAMES ...]

positional arguments:
  IMAGE_FILENAMES       set the image filenames

optional arguments:
  -h, --help            show this help message and exit
  -r RADIUS, --radius RADIUS
                        set the radius or size of edges (default: '1')
  -p PERCENT, --percent PERCENT
                        set the amount of overall strength of sharpening
                        effect (default: '100')
  -t THRESHOLD, --threshold THRESHOLD
                        set the minimum brightness changed to be sharpened
                        (default: '3')
```

### fotolab watermark

```console
fotolab watermark -h
```

```console
usage: fotolab watermark [-h] [-t WATERMARK_TEXT]
                         [-p {top-left,top-right,bottom-left,bottom-right}]
                         [-pd PADDING] [-fs FONT_SIZE] [-fc FONT_COLOR]
                         [-ow OUTLINE_WIDTH] [-oc OUTLINE_COLOR]
                         IMAGE_FILENAMES [IMAGE_FILENAMES ...]

positional arguments:
  IMAGE_FILENAMES       set the image filenames

optional arguments:
  -h, --help            show this help message and exit
  -t WATERMARK_TEXT, --text WATERMARK_TEXT
                        set the watermark text (default: 'kianmeng.org')
  -p {top-left,top-right,bottom-left,bottom-right}, --position {top-left,top-right,bottom-left,bottom-right}
                        set position of the watermark text (default: 'bottom-
                        left')
  -pd PADDING, --padding PADDING
                        set the padding of the watermark text relative to the
                        image (default: '15')
  -fs FONT_SIZE, --font-size FONT_SIZE
                        set the font size of watermark text (default: '12')
  -fc FONT_COLOR, --font-color FONT_COLOR
                        set the font color of watermark text (default:
                        'white')
  -ow OUTLINE_WIDTH, --outline-width OUTLINE_WIDTH
                        set the outline width of the watermark text (default:
                        '2')
  -oc OUTLINE_COLOR, --outline-color OUTLINE_COLOR
                        set the outline color of the watermark text (default:
                        'black')
```

### fotolab env

```console
fotolab env -h
```

```console
usage: fotolab env [-h]

options:
  -h, --help  show this help message and exit
```

## Copyright and License

Copyright (C) 2024 Kian-Meng Ang

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along
with this program. If not, see <https://www.gnu.org/licenses/>.

The fish logo used in the documentation generated by Sphinx is a public domain
drawing of male freshwater phase [Sockeye (red) salmon (Oncorhynchus nerka)]
(https://en.wikipedia.org/w/index.php?oldid=1186575702) from
<https://commons.wikimedia.org/entity/M2787002>.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fotolab",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "photography, photo",
    "author": null,
    "author_email": "Kian-Meng Ang <kianmeng@cpan.org>",
    "download_url": "https://files.pythonhosted.org/packages/50/4d/57c0aae35fdfcc6c7d49ab4c5722904490c70751ae1cd7dd5432fab02a6c/fotolab-0.14.0.tar.gz",
    "platform": null,
    "description": "# fotolab\n\nA console program to manipulate photos.\n\n## Installation\n\nStable version From PyPI using `pipx`:\n\n```console\npipx install fotolab\n```\n\nStable version From PyPI using `pip`:\n\n```console\npython -m pip install fotolab\n```\n\nUpgrade to latest stable version:\n\n```console\npython3 -m pip install fotolab --upgrade\n```\n\nLatest development version from GitHub:\n\n```console\npython -m pip install -e git+https://github.com/kianmeng/fotolab.git\n```\n\n## Usage\n\n```console\nfotolab -h\n```\n\n```console\n\nusage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-d] [-V]\n               {animate,auto,border,contrast,info,resize,montage,sharpen,watermark,env}\n               ...\n\nA console program to manipulate photos.\n\n  website: https://github.com/kianmeng/fotolab\n  changelog: https://github.com/kianmeng/fotolab/blob/master/CHANGELOG.md\n  issues: https://github.com/kianmeng/fotolab/issues\n\npositional arguments:\n  {animate,auto,border,contrast,info,resize,montage,sharpen,watermark,env}\n                    sub-command help\n    animate         animate an image\n    auto            auto adjust (resize, contrast, and watermark) a photo\n    border          add border to image\n    contrast        contrast an image\n    info            info an image\n    resize          resize an image\n    montage         montage a list of image\n    sharpen         sharpen an image\n    watermark       watermark an image\n    env             print environment information for bug reporting\n\noptional arguments:\n  -h, --help        show this help message and exit\n  -o, --overwrite   overwrite existing image\n  -op, --open       open the image using default program (default: 'False')\n  -od OUTPUT_DIR, --output-dir OUTPUT_DIR\n                    set default output folder (default: 'output')\n  -q, --quiet       suppress all logging\n  -d, --debug       show debugging log and stacktrace\n  -V, --version     show program's version number and exit\n```\n\n### fotolab animate\n\n```console\nfotolab animate -h\n```\n\n```console\n\nusage: fotolab animate [-h] [-f FORMAT] [-d DURATION] [-l LOOP]\n                       IMAGE_FILENAMES [IMAGE_FILENAMES ...]\n\npositional arguments:\n  IMAGE_FILENAMES       set the image filenames\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -f FORMAT, --format FORMAT\n                        set the image format (default: 'gif')\n  -d DURATION, --duration DURATION\n                        set the duration in milliseconds (default: '2500')\n  -l LOOP, --loop LOOP  set the loop cycle (default: '0')\n```\n\n### fotolab auto\n\n```console\nfotolab auto -h\n```\n\n```console\nusage: fotolab auto [-h] IMAGE_FILENAMES [IMAGE_FILENAMES ...]\n\npositional arguments:\n  IMAGE_FILENAMES  set the image filename\n\noptional arguments:\n  -h, --help       show this help message and exit\n```\n\n### fotolab border\n\n```console\nfotolab border -h\n```\n\n```console\nusage: fotolab border [-h] [-c COLOR] [-w WIDTH] [-wt WIDTH] [-wr WIDTH]\n                      [-wb WIDTH] [-wl WIDTH]\n                      IMAGE_FILENAMES [IMAGE_FILENAMES ...]\n\npositional arguments:\n  IMAGE_FILENAMES       set the image filenames\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -c COLOR, --color COLOR\n                        set the color of border (default: 'black')\n  -w WIDTH, --width WIDTH\n                        set the width of border (default: '10')\n  -wt WIDTH, --width-top WIDTH\n                        set the width of top border (default: '0')\n  -wr WIDTH, --width-right WIDTH\n                        set the width of right border (default: '0')\n  -wb WIDTH, --width-bottom WIDTH\n                        set the width of bottom border (default: '0')\n  -wl WIDTH, --width-left WIDTH\n                        set the width of left border (default: '0')\n```\n\n### fotolab contrast\n\n```console\nfotolab contrast -h\n```\n\n```console\nusage: fotolab contrast [-h] [-c CUTOFF] IMAGE_FILENAMES [IMAGE_FILENAMES ...]\n\npositional arguments:\n  IMAGE_FILENAMES       set the image filename\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -c CUTOFF, --cutoff CUTOFF\n                        set the percentage of lightest or darkest pixels to\n                        discard from histogram (default: '1')\n```\n\n### fotolab info\n\n```console\nfotolab info -h\n```\n\n```console\nusage: fotolab info [-h] IMAGE_FILENAME\n\npositional arguments:\n  IMAGE_FILENAME  set the image filename\n\noptional arguments:\n  -h, --help      show this help message and exit\n```\n\n### fotolab montage\n\n```console\nfotolab montage -h\n```\n\n```console\n\nusage: fotolab montage [-h] IMAGE_FILENAMES [IMAGE_FILENAMES ...]\n\npositional arguments:\n  IMAGE_FILENAMES  set the image filenames\n\noptional arguments:\n  -h, --help       show this help message and exit\n```\n\n### fotolab resize\n\n```console\nfotolab resize -h\n```\n\n```console\nusage: fotolab resize [-h] [-wh WIDTH] [-ht HEIGHT]\n                      IMAGE_FILENAMES [IMAGE_FILENAMES ...]\n\npositional arguments:\n  IMAGE_FILENAMES       set the image filename\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -wh WIDTH, --width WIDTH\n                        set the width of the image (default: '600')\n  -ht HEIGHT, --height HEIGHT\n                        set the height of the image (default: '277')\n```\n\n### fotolab sharpen\n\n```console\nfotolab sharpen -h\n```\n\n```console\nusage: fotolab sharpen [-h] [-r RADIUS] [-p PERCENT] [-t THRESHOLD]\n                       IMAGE_FILENAMES [IMAGE_FILENAMES ...]\n\npositional arguments:\n  IMAGE_FILENAMES       set the image filenames\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -r RADIUS, --radius RADIUS\n                        set the radius or size of edges (default: '1')\n  -p PERCENT, --percent PERCENT\n                        set the amount of overall strength of sharpening\n                        effect (default: '100')\n  -t THRESHOLD, --threshold THRESHOLD\n                        set the minimum brightness changed to be sharpened\n                        (default: '3')\n```\n\n### fotolab watermark\n\n```console\nfotolab watermark -h\n```\n\n```console\nusage: fotolab watermark [-h] [-t WATERMARK_TEXT]\n                         [-p {top-left,top-right,bottom-left,bottom-right}]\n                         [-pd PADDING] [-fs FONT_SIZE] [-fc FONT_COLOR]\n                         [-ow OUTLINE_WIDTH] [-oc OUTLINE_COLOR]\n                         IMAGE_FILENAMES [IMAGE_FILENAMES ...]\n\npositional arguments:\n  IMAGE_FILENAMES       set the image filenames\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -t WATERMARK_TEXT, --text WATERMARK_TEXT\n                        set the watermark text (default: 'kianmeng.org')\n  -p {top-left,top-right,bottom-left,bottom-right}, --position {top-left,top-right,bottom-left,bottom-right}\n                        set position of the watermark text (default: 'bottom-\n                        left')\n  -pd PADDING, --padding PADDING\n                        set the padding of the watermark text relative to the\n                        image (default: '15')\n  -fs FONT_SIZE, --font-size FONT_SIZE\n                        set the font size of watermark text (default: '12')\n  -fc FONT_COLOR, --font-color FONT_COLOR\n                        set the font color of watermark text (default:\n                        'white')\n  -ow OUTLINE_WIDTH, --outline-width OUTLINE_WIDTH\n                        set the outline width of the watermark text (default:\n                        '2')\n  -oc OUTLINE_COLOR, --outline-color OUTLINE_COLOR\n                        set the outline color of the watermark text (default:\n                        'black')\n```\n\n### fotolab env\n\n```console\nfotolab env -h\n```\n\n```console\nusage: fotolab env [-h]\n\noptions:\n  -h, --help  show this help message and exit\n```\n\n## Copyright and License\n\nCopyright (C) 2024 Kian-Meng Ang\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU Affero General Public License as published by the Free\nSoftware Foundation, either version 3 of the License, or (at your option) any\nlater version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License along\nwith this program. If not, see <https://www.gnu.org/licenses/>.\n\nThe fish logo used in the documentation generated by Sphinx is a public domain\ndrawing of male freshwater phase [Sockeye (red) salmon (Oncorhynchus nerka)]\n(https://en.wikipedia.org/w/index.php?oldid=1186575702) from\n<https://commons.wikimedia.org/entity/M2787002>.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A console program that manipulate images.",
    "version": "0.14.0",
    "project_urls": {
        "Changelog": "https://github.com/kianmeng/fotolab/blob/master/CHANGELOG.md",
        "Issues": "https://github.com/kianmeng/fotolab/issues",
        "Source": "https://github.com/kianmeng/fotolab"
    },
    "split_keywords": [
        "photography",
        " photo"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "67444d9bd36eeee9113f02801b83f3e91e161091ace6e75abb32abcce2fbbf89",
                "md5": "09420d5d607899bf527de9a3692a3a20",
                "sha256": "2d1a8c72c7220775f4e4f60fad2dbf73673973b71f24da31f48ffa6836313392"
            },
            "downloads": -1,
            "filename": "fotolab-0.14.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "09420d5d607899bf527de9a3692a3a20",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 30181,
            "upload_time": "2024-04-27T16:23:51",
            "upload_time_iso_8601": "2024-04-27T16:23:51.722394Z",
            "url": "https://files.pythonhosted.org/packages/67/44/4d9bd36eeee9113f02801b83f3e91e161091ace6e75abb32abcce2fbbf89/fotolab-0.14.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "504d57c0aae35fdfcc6c7d49ab4c5722904490c70751ae1cd7dd5432fab02a6c",
                "md5": "b9ce9c3721c52c5aca21e94b8cdfa6b7",
                "sha256": "6b266208bc347b18734999b37abe849edab6a9d4255c30af7fdd30f045c9dc4f"
            },
            "downloads": -1,
            "filename": "fotolab-0.14.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b9ce9c3721c52c5aca21e94b8cdfa6b7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 64508,
            "upload_time": "2024-04-27T16:23:58",
            "upload_time_iso_8601": "2024-04-27T16:23:58.045006Z",
            "url": "https://files.pythonhosted.org/packages/50/4d/57c0aae35fdfcc6c7d49ab4c5722904490c70751ae1cd7dd5432fab02a6c/fotolab-0.14.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-27 16:23:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kianmeng",
    "github_project": "fotolab",
    "github_not_found": true,
    "lcname": "fotolab"
}
        
Elapsed time: 0.24806s