| Name | safir JSON |
| Version |
5.2.2
JSON |
| download |
| home_page | |
| Summary | The Rubin Observatory SQuaRE framework for FastAPI services. |
| upload_time | 2024-03-15 23:03:20 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.11 |
| license | 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. |
| keywords |
rubin
lsst
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Safir
Safir is Rubin Observatory's library for building [FastAPI](https://fastapi.tiangolo.com/) services for the [Rubin Science Platform (Phalanx)](https://github.com/lsst-sqre/phalanx) and [Roundtable](https://github.com/lsst-sqre/roundtable) Kubernetes clusters.
Safir is developed, maintained, and field tested by the SQuaRE team.
Safir is available from [PyPI](https://pypi.org/project/safir/):
```sh
pip install safir
```
The best way to create a new FastAPI/Safir service is with the [`fastapi_safir_app` template](https://github.com/lsst/templates/blob/main/project_templates/fastapi_safir_app).
Read more about Safir at https://safir.lsst.io.
## Features
- Set up an `httpx.AsyncClient` as part of the application start-up and shutdown 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.
- Process `X-Forwarded-*` headers to determine the source IP and related information of the request.
- Gather and structure standard metadata about your application.
- Operate a distributed Redis job queue with [arq](https://arq-docs.helpmanual.io) using convenient clients, testing mocks, and a FastAPI dependency.
## Developing Safir
The best way to start contributing to Safir is by cloning this repository creating a virtual environment, and running the init command:
```sh
git clone https://github.com/lsst-sqre/safir.git
cd safir
make init
```
For details, see https://safir.lsst.io/dev/development.html.
Raw data
{
"_id": null,
"home_page": "",
"name": "safir",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "rubin,lsst",
"author": "",
"author_email": "\"Association of Universities for Research in Astronomy, Inc. (AURA)\" <sqre-admin@lists.lsst.org>",
"download_url": "https://files.pythonhosted.org/packages/aa/22/0df4bb94b55b1c381b81f1fbfd1667b0b26b0f7fd9e8294b69badfc1ab57/safir-5.2.2.tar.gz",
"platform": null,
"description": "# Safir\n\nSafir is Rubin Observatory's library for building [FastAPI](https://fastapi.tiangolo.com/) services for the [Rubin Science Platform (Phalanx)](https://github.com/lsst-sqre/phalanx) and [Roundtable](https://github.com/lsst-sqre/roundtable) Kubernetes clusters.\nSafir is developed, maintained, and field tested by the SQuaRE team.\n\nSafir is available from [PyPI](https://pypi.org/project/safir/):\n\n```sh\npip install safir\n```\n\nThe best way to create a new FastAPI/Safir service is with the [`fastapi_safir_app` template](https://github.com/lsst/templates/blob/main/project_templates/fastapi_safir_app).\n\nRead more about Safir at https://safir.lsst.io.\n\n## Features\n\n- Set up an `httpx.AsyncClient` as part of the application start-up and shutdown 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- Process `X-Forwarded-*` headers to determine the source IP and related information of the request.\n- Gather and structure standard metadata about your application.\n- Operate a distributed Redis job queue with [arq](https://arq-docs.helpmanual.io) using convenient clients, testing mocks, and a FastAPI dependency.\n\n## Developing Safir\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```sh\ngit clone https://github.com/lsst-sqre/safir.git\ncd safir\nmake init\n```\n\nFor details, see https://safir.lsst.io/dev/development.html.\n",
"bugtrack_url": null,
"license": "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. ",
"summary": "The Rubin Observatory SQuaRE framework for FastAPI services.",
"version": "5.2.2",
"project_urls": {
"Change log": "https://safir.lsst.io/changelog.html",
"Homepage": "https://safir.lsst.io",
"Issue tracker": "https://github.com/lsst-sqre/safir/issues",
"Source": "https://github.com/lsst-sqre/safir"
},
"split_keywords": [
"rubin",
"lsst"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5fac7e9f4b595e0f54410d2a32c42907b93961d62e505eb45597af39d03f9016",
"md5": "54a813d85bd30aebcebc7121145213ab",
"sha256": "13069fb1413443be3685e337ce54f25fc427a86ff718c1e3ca44daaaf5c03d34"
},
"downloads": -1,
"filename": "safir-5.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54a813d85bd30aebcebc7121145213ab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 74682,
"upload_time": "2024-03-15T23:03:17",
"upload_time_iso_8601": "2024-03-15T23:03:17.751792Z",
"url": "https://files.pythonhosted.org/packages/5f/ac/7e9f4b595e0f54410d2a32c42907b93961d62e505eb45597af39d03f9016/safir-5.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aa220df4bb94b55b1c381b81f1fbfd1667b0b26b0f7fd9e8294b69badfc1ab57",
"md5": "18b39be642452eb69ba32ac85dc8a5b0",
"sha256": "e6ad2553e60d1b74bfdbb47bda83776843bb74c3599760b66391253bb0bd4ddb"
},
"downloads": -1,
"filename": "safir-5.2.2.tar.gz",
"has_sig": false,
"md5_digest": "18b39be642452eb69ba32ac85dc8a5b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 164166,
"upload_time": "2024-03-15T23:03:20",
"upload_time_iso_8601": "2024-03-15T23:03:20.047453Z",
"url": "https://files.pythonhosted.org/packages/aa/22/0df4bb94b55b1c381b81f1fbfd1667b0b26b0f7fd9e8294b69badfc1ab57/safir-5.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-15 23:03:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lsst-sqre",
"github_project": "safir",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "safir"
}
