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.0.3.tar.gz (39.5 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.0.3-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for photoprysm-0.0.3.tar.gz
Algorithm Hash digest
SHA256 86d5c91186ed6532b77298ce62c998e157cf9670987c09f890bfc1d01d81ab68
MD5 3005204d832ac4b1d854028c39561911
BLAKE2b-256 59fed0ea85f9d30ab3cdf78c7dbfccef89a55f5ee2efbdd884a84292c7f65c50

See more details on using hashes here.

File details

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

File metadata

  • Download URL: photoprysm-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 17.9 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.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3da8bf56bebbb3dc656d0089c5d39465553a15f9bff4d252b653da549a3585f8
MD5 07fe694d1d380b9c337db636eb8adebe
BLAKE2b-256 c6b4488a435bd60e4660c5bc72badd8abc1dc87288559b242b2d00759f9ac00b

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