cone.firebase 1.1.0
Firebase integration for cone.app
License: Simplified BSD
Requires Python: >=3.10
Keywords: cone, node, pyramid, web

.. image:: https://img.shields.io/pypi/v/cone.firebase.svg
    :target: https://pypi.python.org/pypi/cone.firebase
    :alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/dm/cone.firebase.svg
    :target: https://pypi.python.org/pypi/cone.firebase
    :alt: Number of PyPI downloads

.. image:: https://github.com/conestack/cone.firebase/actions/workflows/test.yml/badge.svg
    :target: https://github.com/conestack/cone.firebase/actions/workflows/test.yml
    :alt: Test cone.firebase


This package provides a firebase integration in to cone.app.


Installation
------------

Include ``cone.firebase`` to install dependencies in your application's
``setup.py``.


Configuration
-------------

Adopt your application config ini file to define firebase related API keys.

.. code-block:: ini

    [app:my_app]
    use = egg:cone.app#main

    cone.plugins =
        cone.firebase

    cone.authenticator = firebase

    firebase.web_api_key = xxx
    firebase.service_account_json_file = path/to/service_account.json

also in your ugm.xml you can optionally add the `firebase_user` checkbox:

.. code-block:: xml

    <users_form_attrmap>
        ...
        <elem>
            <key>firebase_user</key>
            <value>Firebase User</value>
        </elem>
    </users_form_attrmap>

When you want to upgrade an existing user to FB, you can do this by checking
`firebase_user` in the user edit form, butt attention: you have to manually
enter the password since the firebase API expects the password in cleartext.

Contributors
============

- Robert Niederreiter
- Phil Auersperg


Changes
=======

1.1.0 (2026-02-03)
------------------

- Refactor package layout to use ``pyproject.toml`` and implicit namespace packages.
  [rnix]

- Initial.
  [rnix, zworkb]



License
=======

Copyright (c) 2021, BlueDynamics Alliance, Austria
Copyright (c) 2021-2025, Cone Contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this
  list of conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.