.. image:: https://github.com/ome/omero-signup/workflows/OMERO/badge.svg
:target: https://github.com/ome/omero-signup/actions
.. image:: https://badge.fury.io/py/omero-signup.svg
:target: https://badge.fury.io/py/omero-signup
OMERO.signup
============
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.
Requirements
------------
* OMERO.web 5.6 or newer.
* Python 3.6 or newer.
Installation
------------
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
- ``omero.web.signup.group.name``: Default group for new users, will be created if it doesn't exist
Optional configuration settings:
- ``omero.web.signup.group.templatetime``: If ``True`` expand ``omero.web.signup.group.name`` using ``strftime`` to enable time-based groups, default disabled
- ``omero.web.signup.group.perms``: 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:
- ``omero.web.signup.email.enabled``: If ``True`` send emails to new users with their username and password instead of displaying the password, default disabled
- ``omero.web.signup.email.subject``: Email subject for new-user emails
- ``omero.web.signup.email.body``: 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.
Example:
::
$ omero config get
omero.web.apps=["omero_signup"]
omero.web.signup.admin.password=root-password
omero.web.signup.admin.user=root
omero.web.signup.group.name=testgroup-%Y-%m
omero.web.signup.group.templatetime=true
Restart OMERO.web in the usual way.
::
$ omero web restart
New users will be able to sign-up for an account at http://omero.web.host/signup.
Release process
---------------
Use `bumpversion
<https://pypi.org/project/bump2version/>`_ to increment the version, commit and tag the repo.
::
$ bumpversion patch
$ git push origin master
$ git push --tags
License
-------
OMERO.signup is released under the AGPL.
Copyright
---------
2019, The Open Microscopy Environment
Raw data
{
"_id": null,
"home_page": "https://github.com/ome/omero-signup",
"name": "omero-signup",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "OMERO.web,plugin",
"author": "The Open Microscopy Team",
"author_email": "ome-devel@lists.openmicroscopy.org.uk",
"download_url": "https://files.pythonhosted.org/packages/8f/6d/cf6cdef207bcb83793064be11684941f0f80b656ed86d20389caf0dcb4e7/omero-signup-0.3.3.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/ome/omero-signup/workflows/OMERO/badge.svg\n :target: https://github.com/ome/omero-signup/actions\n\n.. image:: https://badge.fury.io/py/omero-signup.svg\n :target: https://badge.fury.io/py/omero-signup\n\nOMERO.signup\n============\nOMERO.web app to allow anyone to signup for an OMERO account.\n\nGenerated 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.\nIf OMERO.web is configured to connect to multiple OMERO servers the user account will be created on the default one.\n\n\nRequirements\n------------\n\n* OMERO.web 5.6 or newer.\n* Python 3.6 or newer.\n\n\nInstallation\n------------\n\nThis section assumes that an OMERO.web is already installed.\n\n::\n\n $ pip install omero-signup\n $ omero config append omero.web.apps '\"omero_signup\"'\n\nRequired configuration settings:\n\n- ``omero.web.signup.admin.user``: OMERO admin username, must have permission to create groups and users\n- ``omero.web.signup.admin.password``: Password for OMERO admin username\n- ``omero.web.signup.group.name``: Default group for new users, will be created if it doesn't exist\n\n\nOptional configuration settings:\n\n- ``omero.web.signup.group.templatetime``: If ``True`` expand ``omero.web.signup.group.name`` using ``strftime`` to enable time-based groups, default disabled\n- ``omero.web.signup.group.perms``: Permissions on default group for new users if it doesn't exist\n\nThese configuration settings are untested due to the difficulty of configuring email on a test server:\n\n- ``omero.web.signup.email.enabled``: If ``True`` send emails to new users with their username and password instead of displaying the password, default disabled\n- ``omero.web.signup.email.subject``: Email subject for new-user emails\n- ``omero.web.signup.email.body``: Email body for new-user emails.\n It should include template strings ``{username}`` and ``{password}`` that will be substituted with the created user's username and password.\n\nExample:\n\n::\n\n $ omero config get\n omero.web.apps=[\"omero_signup\"]\n omero.web.signup.admin.password=root-password\n omero.web.signup.admin.user=root\n omero.web.signup.group.name=testgroup-%Y-%m\n omero.web.signup.group.templatetime=true\n\n\nRestart OMERO.web in the usual way.\n\n::\n\n $ omero web restart\n\n\nNew users will be able to sign-up for an account at http://omero.web.host/signup.\n\n\nRelease process\n---------------\n\nUse `bumpversion\n<https://pypi.org/project/bump2version/>`_ to increment the version, commit and tag the repo.\n\n::\n\n $ bumpversion patch\n $ git push origin master\n $ git push --tags\n\n\nLicense\n-------\n\nOMERO.signup is released under the AGPL.\n\nCopyright\n---------\n\n2019, The Open Microscopy Environment\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "A Python plugin for OMERO.web",
"version": "0.3.3",
"project_urls": {
"Download": "https://github.com/ome/omero-signup/archive/v0.3.3.tar.gz",
"Homepage": "https://github.com/ome/omero-signup"
},
"split_keywords": [
"omero.web",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4637adf63a82ea8b7b414d7e1272d7284af20cd5e8cad74f1204ff623816053d",
"md5": "a338e5d79413609c1b1bbae8d0fc067e",
"sha256": "b36adc863c8e96486b5e9c06c1e152f269604bbc6f1da4d95e06c8e8a55914aa"
},
"downloads": -1,
"filename": "omero_signup-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a338e5d79413609c1b1bbae8d0fc067e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 24288,
"upload_time": "2023-10-24T12:57:23",
"upload_time_iso_8601": "2023-10-24T12:57:23.956214Z",
"url": "https://files.pythonhosted.org/packages/46/37/adf63a82ea8b7b414d7e1272d7284af20cd5e8cad74f1204ff623816053d/omero_signup-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f6dcf6cdef207bcb83793064be11684941f0f80b656ed86d20389caf0dcb4e7",
"md5": "e6c0b02b4239a7632143be3951aff1a7",
"sha256": "e2c367bdcb867aaa8fd273c630f6b80c892d52b25afeae371eb3a6ed9bdf2d96"
},
"downloads": -1,
"filename": "omero-signup-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "e6c0b02b4239a7632143be3951aff1a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 22554,
"upload_time": "2023-10-24T12:57:25",
"upload_time_iso_8601": "2023-10-24T12:57:25.303326Z",
"url": "https://files.pythonhosted.org/packages/8f/6d/cf6cdef207bcb83793064be11684941f0f80b656ed86d20389caf0dcb4e7/omero-signup-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-24 12:57:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ome",
"github_project": "omero-signup",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "omero-signup"
}
JSON
