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.2.tar.gz (38.2 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.2-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for photoprysm-0.0.2.tar.gz
Algorithm Hash digest
SHA256 89f6630d4e574435b7df2074c923c75760965e82dde111f82da214c85c81f211
MD5 35b44e6008a1d5e609483c18e4b1578e
BLAKE2b-256 53d6cc5fa1636254bfe529251818cbdf8652238946df57e601fe978bee2b6b4d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for photoprysm-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a821a24876239338a2aa47c906bee91b835bdb40836eb15e51271122a8b6d535
MD5 74d042901e0d7ca0e2eed4ce4e93fc88
BLAKE2b-256 c4e9fa6788e90daf3081a9bcb128c4ad599237cb3f77fe3fd2945210eecc8961

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