photocrawl


Namephotocrawl JSON
Version 0.3.2 PyPI version JSON
download
home_pageNone
SummaryPackage for analysis of photography habits.
upload_time2024-07-26 14:38:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords photography utility visualisation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">
  <b>photocrawl</b>
</h1>

A simple package to run analysis and get insight on my use of equipment and settings in my practice of photography.

## Install

This code is compatible with all currently supported Python versions, and requires that you have the great [ExifTool][exiftool] package by Phil Harvey in your `PATH`.
You can install it in your virtual enrivonment with:

```bash
python -m pip install photocrawl
```

## Usage

With this package installed in the activated enrivonment, it can be called through `python -m photocrawl` or through a newly created `photocrawl` command.

Detailed usage goes as follows:

```bash
 Usage: python -m photocrawl [OPTIONS] [IMAGES]                                   
                                                                                  
 Crawl and ensemble of pictures to run analysis of their metadata and get insight 
 on one's use of equipment and settings in their practice of photography.         
                                                                                  
╭─ Arguments ────────────────────────────────────────────────────────────────────╮
│   images      [IMAGES]  Location, relative or absolute, of the images          │
│                         directory you wish to crawl.                           │
│                         [default: None]                                        │
╰────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ──────────────────────────────────────────────────────────────────────╮
│ --output-dir                                 TEXT  Location, either relative   │
│                                                    or absolute, of the output  │
│                                                    directory.                  │
│                                                    [default: outputs]          │
│ --show-figures          --no-show-figures          Whether or not to show      │
│                                                    figures when plotting       │
│                                                    insights.                   │
│                                                    [default: no-show-figures]  │
│ --save-figures          --no-save-figures          Whether or not to save      │
│                                                    figures when plotting       │
│                                                    insights.                   │
│                                                    [default: no-save-figures]  │
│ --log-level                                  TEXT  The base console logging    │
│                                                    level. Can be 'debug',      │
│                                                    'info', 'warning' and       │
│                                                    'error'.                    │
│                                                    [default: info]             │
│ --install-completion                               Install completion for the  │
│                                                    current shell.              │
│ --show-completion                                  Show completion for the     │
│                                                    current shell, to copy it   │
│                                                    or customize the            │
│                                                    installation.               │
│ --help                                             Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────╯
```

The script will crawl files, extract EXIF information and output insights visualizations named `insight_1.png` and `insight_2.png` in a newly created `outputs` folder (or a folder named as you specified).

## Output example

Here is an example of what the script outputs:

![Example_1](example_outputs/insight_1.jpg)

![Example_2](example_outputs/insight_2.jpg)

## TODO

- [x] Handling raw files.
- [x] Handling subfolders when looking for files.
- [x] Output all insight in a single/two plot.
- [x] Implement proper logging.
- [x] Make into a package.
- [x] Make callable as a python module (`python -m photocrawl ...`).
- [x] Improving the command line experience.

---

<div align="center">
  <sub><strong>Made with ♥︎ by fsoubelet</strong></sub>
  <br>
  <sub><strong>MIT &copy 2019 Felix Soubelet</strong></sub>
</div>


[exiftool]: https://www.sno.phy.queensu.ca/~phil/exiftool/

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "photocrawl",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "Photography, Utility, Visualisation",
    "author": null,
    "author_email": "Felix Soubelet <felix.soubelet@cern.ch>",
    "download_url": "https://files.pythonhosted.org/packages/5c/43/bb00e714eb43b1b847229f5dd63dcd109b887887366a403fd1dcd046b44f/photocrawl-0.3.2.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">\n  <b>photocrawl</b>\n</h1>\n\nA simple package to run analysis and get insight on my use of equipment and settings in my practice of photography.\n\n## Install\n\nThis code is compatible with all currently supported Python versions, and requires that you have the great [ExifTool][exiftool] package by Phil Harvey in your `PATH`.\nYou can install it in your virtual enrivonment with:\n\n```bash\npython -m pip install photocrawl\n```\n\n## Usage\n\nWith this package installed in the activated enrivonment, it can be called through `python -m photocrawl` or through a newly created `photocrawl` command.\n\nDetailed usage goes as follows:\n\n```bash\n Usage: python -m photocrawl [OPTIONS] [IMAGES]                                   \n                                                                                  \n Crawl and ensemble of pictures to run analysis of their metadata and get insight \n on one's use of equipment and settings in their practice of photography.         \n                                                                                  \n\u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502   images      [IMAGES]  Location, relative or absolute, of the images          \u2502\n\u2502                         directory you wish to crawl.                           \u2502\n\u2502                         [default: None]                                        \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --output-dir                                 TEXT  Location, either relative   \u2502\n\u2502                                                    or absolute, of the output  \u2502\n\u2502                                                    directory.                  \u2502\n\u2502                                                    [default: outputs]          \u2502\n\u2502 --show-figures          --no-show-figures          Whether or not to show      \u2502\n\u2502                                                    figures when plotting       \u2502\n\u2502                                                    insights.                   \u2502\n\u2502                                                    [default: no-show-figures]  \u2502\n\u2502 --save-figures          --no-save-figures          Whether or not to save      \u2502\n\u2502                                                    figures when plotting       \u2502\n\u2502                                                    insights.                   \u2502\n\u2502                                                    [default: no-save-figures]  \u2502\n\u2502 --log-level                                  TEXT  The base console logging    \u2502\n\u2502                                                    level. Can be 'debug',      \u2502\n\u2502                                                    'info', 'warning' and       \u2502\n\u2502                                                    'error'.                    \u2502\n\u2502                                                    [default: info]             \u2502\n\u2502 --install-completion                               Install completion for the  \u2502\n\u2502                                                    current shell.              \u2502\n\u2502 --show-completion                                  Show completion for the     \u2502\n\u2502                                                    current shell, to copy it   \u2502\n\u2502                                                    or customize the            \u2502\n\u2502                                                    installation.               \u2502\n\u2502 --help                                             Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\nThe script will crawl files, extract EXIF information and output insights visualizations named `insight_1.png` and `insight_2.png` in a newly created `outputs` folder (or a folder named as you specified).\n\n## Output example\n\nHere is an example of what the script outputs:\n\n![Example_1](example_outputs/insight_1.jpg)\n\n![Example_2](example_outputs/insight_2.jpg)\n\n## TODO\n\n- [x] Handling raw files.\n- [x] Handling subfolders when looking for files.\n- [x] Output all insight in a single/two plot.\n- [x] Implement proper logging.\n- [x] Make into a package.\n- [x] Make callable as a python module (`python -m photocrawl ...`).\n- [x] Improving the command line experience.\n\n---\n\n<div align=\"center\">\n  <sub><strong>Made with \u2665\ufe0e by fsoubelet</strong></sub>\n  <br>\n  <sub><strong>MIT &copy 2019 Felix Soubelet</strong></sub>\n</div>\n\n\n[exiftool]: https://www.sno.phy.queensu.ca/~phil/exiftool/\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Package for analysis of photography habits.",
    "version": "0.3.2",
    "project_urls": {
        "documentation": "https://fsoubelet.github.io/PhotoCrawl/",
        "homepage": "https://github.com/fsoubelet/PhotoCrawl",
        "repository": "https://github.com/fsoubelet/PhotoCrawl"
    },
    "split_keywords": [
        "photography",
        " utility",
        " visualisation"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f348c4c7417ddf7746b1ff5b2c6a7d82cbe11bd200f5c0dec15aceba1b52dced",
                "md5": "5946d99d6f17f9f51f9a528a3ab86d89",
                "sha256": "140d71ea1c52ff583403f4e47717718a70e6f45e2dbb38d365d4c3ed948f0d5b"
            },
            "downloads": -1,
            "filename": "photocrawl-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5946d99d6f17f9f51f9a528a3ab86d89",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11346,
            "upload_time": "2024-07-26T14:38:37",
            "upload_time_iso_8601": "2024-07-26T14:38:37.241647Z",
            "url": "https://files.pythonhosted.org/packages/f3/48/c4c7417ddf7746b1ff5b2c6a7d82cbe11bd200f5c0dec15aceba1b52dced/photocrawl-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5c43bb00e714eb43b1b847229f5dd63dcd109b887887366a403fd1dcd046b44f",
                "md5": "40b454f9cea5a0e38e00e6676a877cd4",
                "sha256": "c8662f5032615b29392f1de9de033ad87f65a63b124097b2725a81d1fec074fc"
            },
            "downloads": -1,
            "filename": "photocrawl-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "40b454f9cea5a0e38e00e6676a877cd4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 7911943,
            "upload_time": "2024-07-26T14:38:39",
            "upload_time_iso_8601": "2024-07-26T14:38:39.916595Z",
            "url": "https://files.pythonhosted.org/packages/5c/43/bb00e714eb43b1b847229f5dd63dcd109b887887366a403fd1dcd046b44f/photocrawl-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-26 14:38:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fsoubelet",
    "github_project": "PhotoCrawl",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "photocrawl"
}
        
Elapsed time: 0.33723s