Skip to main content

A Python client for interacting the the Photoprism REST API.

Project description

https://img.shields.io/pypi/v/photoprysm.svg Documentation Status

A Python client for interacting the the Photoprism REST API.

Features

  • Made to work with the popular Requests package

  • Session management for both Users and Clients

Quickstart

To start, you need a User or Client instance.

>>> import photoprysm
>>> user = photoprysm.User('username', 'password')
>>> server_api = photoprysm.get_api_url('localhost:2342')

You can either login with the User or Client handle and log out later…

>>> session = user.login(server_api)
>>> # Do some stuff
>>> user.logout()

Or you can use the context manager so that it will log out automatically when you are done.

>>> with photoprysm.user_session(user, server_api) as session:
>>>     # Do some stuff
>>> # Logged out

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

photoprysm-0.1.0.tar.gz (43.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

photoprysm-0.1.0-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

Details for the file photoprysm-0.1.0.tar.gz.

File metadata

  • Download URL: photoprysm-0.1.0.tar.gz
  • Upload date:
  • Size: 43.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for photoprysm-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a93cef0168dd269c8f55059671e04f6babc1b064d47bcdbc7be58864b3f9e6a3
MD5 9640d268dedb1e288212005bcc1533e2
BLAKE2b-256 d7366559fa5d3e3ac83fca31bf1bcc5b47bbe22e2e0a4abf08fcb9c6c06a4137

See more details on using hashes here.

File details

Details for the file photoprysm-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: photoprysm-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for photoprysm-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 609281a81476575d98027a9d030007bf4e6c8b17bd1ae15b23a10efcf5205a8a
MD5 7395df1c757319a214a735e3a1c9c1a8
BLAKE2b-256 e85abc94df56c7c99f3e7fb82cb524768c3d3915baf4599a3569ae634e8cbbca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page