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.1.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.1-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: photoprysm-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 636721223b51d760b752c60b3962f6e1bc1222695d87a132d7b28757dd065d1f
MD5 382738a9818084681d3f43d6d0ad4559
BLAKE2b-256 0bb1666082f0c77c72ad5f7ad3cc4f924272e064bbcf9a26d0e8670472bab141

See more details on using hashes here.

File details

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

File metadata

  • Download URL: photoprysm-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 45ba2aff9e521c717fee94635ff08dc05e2f675028da979787574060328aa35e
MD5 cbf8fddecd510d247f231d43df3362e3
BLAKE2b-256 249528929a08a3c85955114bb35476e935ecc7fb94d664fb2dfed5e23562dcff

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