|gh-test| |pypi|
.. |gh-test| image:: https://img.shields.io/github/actions/workflow/status/RKrahl/photoidx/run-tests.yaml?branch=develop
:target: https://github.com/RKrahl/photoidx/actions/workflows/run-tests.yaml
:alt: GitHub Workflow Status
.. |pypi| image:: https://img.shields.io/pypi/v/photoidx
:target: https://pypi.org/project/photoidx/
:alt: PyPI version
photoidx - Maintain indices for photo collections
=================================================
This package maintains indices for photo collections. The index is
stored as a YAML file and contains metadata and tags describing the
photos. The photos are accessed read only.
The package provides a command line tool to create and manipulate the
index and a graphical image viewer.
System requirements
-------------------
Python:
+ Python 3.6 or newer.
Required library packages:
+ `setuptools`_
+ `packaging`_
+ `PyYAML`_
+ `ExifRead`_ >= 2.2.0
+ `PySide2`_
Optional library packages:
+ `vignette`_ >= 4.3.0
Needed to cache thumbnail images for the overview window. If
vignette is not available, everything will still work, but
displaying the overview window may be significantly slower.
+ vignette needs at least one thumbnail backend, for instance
`Pillow`_ >= 6.0 or `PyQt5`_, see the vignette documentation for
details. If no suitable backend is found, vignette will be disabled
in photoidx.
+ `setuptools_scm`_
The version number is managed using this package. All source
distributions add a static text file with the version number and
fall back using that if `setuptools_scm` is not available. So this
package is only needed to build out of the plain development source
tree as cloned from GitHub.
+ `pytest`_ >= 3.0.0
Only needed to run the test suite.
+ `pytest-dependency`_
Only needed to run the test suite. (Actually, you can run the test
suite even without it, but dependencies between tests will be
ignored then.)
+ `distutils-pytest`_
Only needed to run the test suite.
Install instructions
--------------------
Note that the GUI of photoidx requires PySide2, but the installation
of PySide2 using pip seem to be thoroughly broken. That is why that
dependency is deliberately omitted in the setup script of photoidx.
You need to install PySide2 independently before installing photoidx.
It is advisable to install PySide2 using the package manager of your
operating system rather than from PyPI.
Furthermore, you may want to install vignette along with a thumbnail
backend to enable cached thumbnails in the overview window. This also
needs to be installed independently.
Release packages of photoidx are published in the `Python Package
Index (PyPI)`__.
.. __: `PyPI site`_
Installation using pip
......................
You can install photoidx from PyPI using pip::
$ pip install photoidx
Installation from the source distribution
.........................................
Steps to manually build from the source distribution:
1. Download the sources, unpack, and change into the source directory.
2. Build::
$ python setup.py build
3. Test (optional)::
$ python setup.py test
4. Install::
$ python setup.py install
The last step might require admin privileges in order to write into
the site-packages directory of your Python installation.
Note that this still requires a release version of the source
distribution. The development sources that you may clone from the
source repository on GitHub is missing some files that are dynamically
created during the release.
Copyright and License
---------------------
Copyright 2015–2023 Rolf Krahl
Licensed under the `Apache License`_, Version 2.0 (the "License"); you
may not use this package except in compliance with the License.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the License for the specific language governing
permissions and limitations under the License.
.. _setuptools: https://github.com/pypa/setuptools/
.. _packaging: https://github.com/pypa/packaging/
.. _PyYAML: https://github.com/yaml/pyyaml
.. _ExifRead: https://github.com/ianare/exif-py
.. _PySide2: https://www.pyside.org/
.. _vignette: https://github.com/hydrargyrum/vignette
.. _Pillow: https://python-pillow.org/
.. _PyQt5: https://www.riverbankcomputing.com/software/pyqt/
.. _setuptools_scm: https://github.com/pypa/setuptools_scm/
.. _pytest: https://pytest.org/
.. _pytest-dependency: https://github.com/RKrahl/pytest-dependency
.. _distutils-pytest: https://github.com/RKrahl/distutils-pytest
.. _PyPI site: https://pypi.org/project/photoidx/
.. _Apache License: https://www.apache.org/licenses/LICENSE-2.0
Raw data
{
"_id": null,
"home_page": "https://github.com/RKrahl/photoidx",
"name": "photoidx",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Rolf Krahl",
"author_email": "rolf@rotkraut.de",
"download_url": "https://files.pythonhosted.org/packages/d8/08/1cfc60fc769fd6072629daf747505523fa996e64ec5044cd13b069f2948c/photoidx-0.10.1.tar.gz",
"platform": null,
"description": "|gh-test| |pypi|\n\n.. |gh-test| image:: https://img.shields.io/github/actions/workflow/status/RKrahl/photoidx/run-tests.yaml?branch=develop\n :target: https://github.com/RKrahl/photoidx/actions/workflows/run-tests.yaml\n :alt: GitHub Workflow Status\n\n.. |pypi| image:: https://img.shields.io/pypi/v/photoidx\n :target: https://pypi.org/project/photoidx/\n :alt: PyPI version\n\nphotoidx - Maintain indices for photo collections\n=================================================\n\nThis package maintains indices for photo collections. The index is\nstored as a YAML file and contains metadata and tags describing the\nphotos. The photos are accessed read only.\n\nThe package provides a command line tool to create and manipulate the\nindex and a graphical image viewer.\n\n\nSystem requirements\n-------------------\n\nPython:\n\n+ Python 3.6 or newer.\n\nRequired library packages:\n\n+ `setuptools`_\n\n+ `packaging`_\n\n+ `PyYAML`_\n\n+ `ExifRead`_ >= 2.2.0\n\n+ `PySide2`_\n\nOptional library packages:\n\n+ `vignette`_ >= 4.3.0\n\n Needed to cache thumbnail images for the overview window. If\n vignette is not available, everything will still work, but\n displaying the overview window may be significantly slower.\n\n+ vignette needs at least one thumbnail backend, for instance\n `Pillow`_ >= 6.0 or `PyQt5`_, see the vignette documentation for\n details. If no suitable backend is found, vignette will be disabled\n in photoidx.\n\n+ `setuptools_scm`_\n\n The version number is managed using this package. All source\n distributions add a static text file with the version number and\n fall back using that if `setuptools_scm` is not available. So this\n package is only needed to build out of the plain development source\n tree as cloned from GitHub.\n\n+ `pytest`_ >= 3.0.0\n\n Only needed to run the test suite.\n\n+ `pytest-dependency`_\n\n Only needed to run the test suite. (Actually, you can run the test\n suite even without it, but dependencies between tests will be\n ignored then.)\n\n+ `distutils-pytest`_\n\n Only needed to run the test suite.\n\n\nInstall instructions\n--------------------\n\nNote that the GUI of photoidx requires PySide2, but the installation\nof PySide2 using pip seem to be thoroughly broken. That is why that\ndependency is deliberately omitted in the setup script of photoidx.\nYou need to install PySide2 independently before installing photoidx.\nIt is advisable to install PySide2 using the package manager of your\noperating system rather than from PyPI.\n\nFurthermore, you may want to install vignette along with a thumbnail\nbackend to enable cached thumbnails in the overview window. This also\nneeds to be installed independently.\n\nRelease packages of photoidx are published in the `Python Package\nIndex (PyPI)`__.\n\n.. __: `PyPI site`_\n\nInstallation using pip\n......................\n\nYou can install photoidx from PyPI using pip::\n\n $ pip install photoidx\n\nInstallation from the source distribution\n.........................................\n\nSteps to manually build from the source distribution:\n\n1. Download the sources, unpack, and change into the source directory.\n\n2. Build::\n\n $ python setup.py build\n\n3. Test (optional)::\n\n $ python setup.py test\n\n4. Install::\n\n $ python setup.py install\n\nThe last step might require admin privileges in order to write into\nthe site-packages directory of your Python installation.\n\nNote that this still requires a release version of the source\ndistribution. The development sources that you may clone from the\nsource repository on GitHub is missing some files that are dynamically\ncreated during the release.\n\n\nCopyright and License\n---------------------\n\nCopyright 2015\u20132023 Rolf Krahl\n\nLicensed under the `Apache License`_, Version 2.0 (the \"License\"); you\nmay not use this package except in compliance with the License.\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\nimplied. See the License for the specific language governing\npermissions and limitations under the License.\n\n\n.. _setuptools: https://github.com/pypa/setuptools/\n.. _packaging: https://github.com/pypa/packaging/\n.. _PyYAML: https://github.com/yaml/pyyaml\n.. _ExifRead: https://github.com/ianare/exif-py\n.. _PySide2: https://www.pyside.org/\n.. _vignette: https://github.com/hydrargyrum/vignette\n.. _Pillow: https://python-pillow.org/\n.. _PyQt5: https://www.riverbankcomputing.com/software/pyqt/\n.. _setuptools_scm: https://github.com/pypa/setuptools_scm/\n.. _pytest: https://pytest.org/\n.. _pytest-dependency: https://github.com/RKrahl/pytest-dependency\n.. _distutils-pytest: https://github.com/RKrahl/distutils-pytest\n.. _PyPI site: https://pypi.org/project/photoidx/\n.. _Apache License: https://www.apache.org/licenses/LICENSE-2.0",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Maintain indices for photo collections",
"version": "0.10.1",
"project_urls": {
"Download": "https://github.com/RKrahl/photoidx/releases/latest",
"Homepage": "https://github.com/RKrahl/photoidx",
"Source": "https://github.com/RKrahl/photoidx"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d8081cfc60fc769fd6072629daf747505523fa996e64ec5044cd13b069f2948c",
"md5": "8a3f356392f17f5cd164a9cabc7bc5cb",
"sha256": "af191eea15df438e558f1029d43c80173190dc4c5d7dac8739387e36601a559e"
},
"downloads": -1,
"filename": "photoidx-0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "8a3f356392f17f5cd164a9cabc7bc5cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 506323,
"upload_time": "2023-09-24T08:49:56",
"upload_time_iso_8601": "2023-09-24T08:49:56.430471Z",
"url": "https://files.pythonhosted.org/packages/d8/08/1cfc60fc769fd6072629daf747505523fa996e64ec5044cd13b069f2948c/photoidx-0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-24 08:49:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RKrahl",
"github_project": "photoidx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "photoidx"
}
JSON
