Skip to main content

A Python plugin for OMERO.web

Project description


OMERO.web app to allow anyone to signup for an OMERO account.

Generated usernames are formed from the alphanumeric unicode characters in a user’s first and last names, with a numeric suffix if the username already exists. If OMERO.web is configured to connect to multiple OMERO servers the user account will be created on the default one.


  • OMERO.web 5.6 or newer.

  • Python 3.6 or newer.


This section assumes that an OMERO.web is already installed.

$ pip install omero-signup
$ omero config append omero.web.apps '"omero_signup"'

Required configuration settings:

  • omero.web.signup.admin.user: OMERO admin username, must have permission to create groups and users

  • omero.web.signup.admin.password: Password for OMERO admin username

  • Default group for new users, will be created if it doesn’t exist

Optional configuration settings:

  • If True expand using strftime to enable time-based groups, default disabled

  • Permissions on default group for new users if it doesn’t exist

These configuration settings are untested due to the difficulty of configuring email on a test server:

  • If True send emails to new users with their username and password instead of displaying the password, default disabled

  • Email subject for new-user emails

  • Email body for new-user emails. It should include template strings {username} and {password} that will be substituted with the created user’s username and password.


$ omero config get

Restart OMERO.web in the usual way.

$ omero web restart

New users will be able to sign-up for an account at

Release process

Use bumpversion to increment the version, commit and tag the repo.

$ bumpversion patch
$ git push origin master
$ git push --tags


OMERO.signup is released under the AGPL.

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

omero-signup-0.2.0.tar.gz (23.1 kB view hashes)

Uploaded Source

Built Distribution

omero_signup-0.2.0-py3-none-any.whl (24.3 kB view hashes)

Uploaded Python 3

Supported by

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