safir


Namesafir JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://safir.lsst.io
SummaryThe LSST SQuaRE framework for Roundtable bots.
upload_time2021-06-18 17:15:20
maintainer
docs_urlNone
authorAssociation of Universities for Research in Astronomy, Inc. (AURA)
requires_python>=3.7
licenseMIT
keywords lsst
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ############################################
Safir is the SQuaRE Framework for Roundtable
############################################

Roundtable_ is the SQuaRE application and bot deployment platform, hosted on Kubernetes with Argo CD.
Safir is a Python package that lets you develop Roundtable bots, based on the `aiohttp.web`_ asyncio web framework.

Install from PyPI:

.. code-block:: bash

   pip install safir

The best way to create a new Safir-based Roundtable bot is with the `roundtable_aiohttp_bot`_ template.

Read more about Safir at https://safir.lsst.io

Features
========

- Set up an aiohttp.ClientSession as part of the application start up an tear-down lifecycle.
- Set up structlog-based logging.
- Middleware for attaching request context to the logger to include a request UUID, method, and route in all log messages.
- Gather and structure Roundtable-standard metadata about your application.

Developing Safir
================

The best way to start contributing to Safir is by cloning this repository creating a virtual environment, and running the init command:

.. code-block:: bash

   git clone https://github.com/lsst-sqre/safir.git
   cd safir
   make init

For details, see https://safir.lsst.io/dev/development.html.

.. _Roundtable: https://roundtable.lsst.io
.. _aiohttp.web: https://docs.aiohttp.org/en/stable/web.html
.. _roundtable_aiohttp_bot: https://github.com/lsst/templates/tree/master/project_templates/roundtable_aiohttp_bot

##########
Change log
##########

.. Headline template:
   X.Y.Z (YYYY-MM-DD)

1.0.0 (2021-06-18)
==================

Safir v1 will be the major release supporting aiohttp.
Starting with Safir v2, Safir will become a support library for FastAPI_ applications.

.. _FastAPI: https://fastapi.tiangolo.com/

This release has no significant difference from 0.2.0.
The version bump is to indicate that the aiohttp support is stable.

0.2.0 (2021-06-10)
==================

- ``configure_logging`` now supports an optional ``add_timestamp`` parameter (false by default) that adds a timestamp to each log message.
- Update dependencies.

0.1.1 (2021-01-14)
==================

- Fix duplicated log output when logging is configured multiple times.
- Update dependencies.

0.1.0 (2020-02-26)
==================

- The first release of Safir featuring:
  
  - ``safir.http`` for adding an ``aiohttp.ClientSession`` to your application.
  - ``safir.logging`` for configuring structlog loggers.
  - ``safir.metadata`` helps your gather and structure metadata about your application for publishing on metadata endpoints.
  - ``safir.middleware`` includes a logging middleware that adds a logger with bound context about the request to your Request object.
  - Documentation about these features and a tutorial for starting a new application with the ``roundtable_aiohttp_bot`` template.

MIT License

Copyright (c) 2020 Association of Universities for Research in Astronomy, Inc. (AURA)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



            

Raw data

            {
    "_id": null,
    "home_page": "https://safir.lsst.io",
    "name": "safir",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "lsst",
    "author": "Association of Universities for Research in Astronomy, Inc. (AURA)",
    "author_email": "sqre-admin@lists.lsst.org",
    "download_url": "https://files.pythonhosted.org/packages/ba/04/54fcd772ebb414cb7996e5bb11d222c1d7b4cb97cec5f1dcaa4bcda913ba/safir-1.0.0.tar.gz",
    "platform": "",
    "description": "############################################\nSafir is the SQuaRE Framework for Roundtable\n############################################\n\nRoundtable_ is the SQuaRE application and bot deployment platform, hosted on Kubernetes with Argo CD.\nSafir is a Python package that lets you develop Roundtable bots, based on the `aiohttp.web`_ asyncio web framework.\n\nInstall from PyPI:\n\n.. code-block:: bash\n\n   pip install safir\n\nThe best way to create a new Safir-based Roundtable bot is with the `roundtable_aiohttp_bot`_ template.\n\nRead more about Safir at https://safir.lsst.io\n\nFeatures\n========\n\n- Set up an aiohttp.ClientSession as part of the application start up an tear-down lifecycle.\n- Set up structlog-based logging.\n- Middleware for attaching request context to the logger to include a request UUID, method, and route in all log messages.\n- Gather and structure Roundtable-standard metadata about your application.\n\nDeveloping Safir\n================\n\nThe best way to start contributing to Safir is by cloning this repository creating a virtual environment, and running the init command:\n\n.. code-block:: bash\n\n   git clone https://github.com/lsst-sqre/safir.git\n   cd safir\n   make init\n\nFor details, see https://safir.lsst.io/dev/development.html.\n\n.. _Roundtable: https://roundtable.lsst.io\n.. _aiohttp.web: https://docs.aiohttp.org/en/stable/web.html\n.. _roundtable_aiohttp_bot: https://github.com/lsst/templates/tree/master/project_templates/roundtable_aiohttp_bot\n\n##########\nChange log\n##########\n\n.. Headline template:\n   X.Y.Z (YYYY-MM-DD)\n\n1.0.0 (2021-06-18)\n==================\n\nSafir v1 will be the major release supporting aiohttp.\nStarting with Safir v2, Safir will become a support library for FastAPI_ applications.\n\n.. _FastAPI: https://fastapi.tiangolo.com/\n\nThis release has no significant difference from 0.2.0.\nThe version bump is to indicate that the aiohttp support is stable.\n\n0.2.0 (2021-06-10)\n==================\n\n- ``configure_logging`` now supports an optional ``add_timestamp`` parameter (false by default) that adds a timestamp to each log message.\n- Update dependencies.\n\n0.1.1 (2021-01-14)\n==================\n\n- Fix duplicated log output when logging is configured multiple times.\n- Update dependencies.\n\n0.1.0 (2020-02-26)\n==================\n\n- The first release of Safir featuring:\n  \n  - ``safir.http`` for adding an ``aiohttp.ClientSession`` to your application.\n  - ``safir.logging`` for configuring structlog loggers.\n  - ``safir.metadata`` helps your gather and structure metadata about your application for publishing on metadata endpoints.\n  - ``safir.middleware`` includes a logging middleware that adds a logger with bound context about the request to your Request object.\n  - Documentation about these features and a tutorial for starting a new application with the ``roundtable_aiohttp_bot`` template.\n\nMIT License\n\nCopyright (c) 2020 Association of Universities for Research in Astronomy, Inc. (AURA)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "The LSST SQuaRE framework for Roundtable bots.",
    "version": "1.0.0",
    "split_keywords": [
        "lsst"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "069f3c4979f38fada3e6b43e65a031ca",
                "sha256": "6086fc32c4a95a294ef4fc5520e9bf566585d88e638029509040d2d7a2d4bbb8"
            },
            "downloads": -1,
            "filename": "safir-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "069f3c4979f38fada3e6b43e65a031ca",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 10805,
            "upload_time": "2021-06-18T17:15:19",
            "upload_time_iso_8601": "2021-06-18T17:15:19.282921Z",
            "url": "https://files.pythonhosted.org/packages/d9/fa/c517be3e020b0cab8e7f05dd0bee199ce20c2f7e0f012bcf5ad89485533d/safir-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "7d0d7b4ed37fe00c9bb7f5d194478319",
                "sha256": "43df32e3bd076a5a59e5e69d138e3220304881908669ea3ce4da9a22bf0b9df3"
            },
            "downloads": -1,
            "filename": "safir-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7d0d7b4ed37fe00c9bb7f5d194478319",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 24412,
            "upload_time": "2021-06-18T17:15:20",
            "upload_time_iso_8601": "2021-06-18T17:15:20.713707Z",
            "url": "https://files.pythonhosted.org/packages/ba/04/54fcd772ebb414cb7996e5bb11d222c1d7b4cb97cec5f1dcaa4bcda913ba/safir-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-06-18 17:15:20",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "safir"
}
        
Elapsed time: 0.30106s