logfire-python


Namelogfire-python JSON
Version 0.0.9 PyPI version JSON
download
home_pageNone
SummaryLogfire.ai client library
upload_time2024-05-23 04:51:04
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseNone
keywords api logfire logging client
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Logfire - Python Logging Made Easy


[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
[![PyPI version](https://badge.fury.io/py/logfire-python.svg)](https://badge.fury.io/py/logfire-python)


Collect logs directly from any Python code, including Django.

[Logfire](https://logfire.sh) is a hosted service that centralizes all of your logs into one place. Allowing for analysis, correlation and filtering with SQL. Actionable dashboards and collaboration come built-in. Logfire works with [any language or platform and any data source](https://docs.logfire.sh/). 

### Features
- Simple integration. Integrates with the Python `logging` library.
- Support for structured logging and events.
- Automatically captures useful context.
- Performant, light weight, with a thoughtful design.

### Supported language versions
- Python 3.6.5 or newer
- `pip` 20.0.2 or newer

# Installation
Install the Logfire Python client library using the `pip` command:

```bash
pip install logfire-python
```

*Make sure you install the `logfire-python` package and not a different package with the `logfire` keyword in the package name from a different author.*

---

# Example project

To help you get started with using Logfire in your Python projects, we have prepared a simple Python program that showcases the usage of Logfire logger.

## Download and install the example project

You can download the [example project](https://github.com/logfire-sh/logfire-python/tree/master/example-project) from GitHub directly or you can clone it to a select directory. Then install the `logfire-python` client library as shown before:

```bash
pip install logfire-python
```

 ## Run the example project
 
 To run the example application, simply run the following command:

```bash
python main.py <source-token>
```

*Don't forget to replace `<source-token>` with your actual source token which you can find by going to logfire.com -> sources -> edit.*


If you have trouble running the command above, check your Python installation and try running it with the `python3` command instead. It should give you the following output:

```
Output:
All done! You can check your logs now.
```

This example project will create a total of 6 logs. Each corresponding to its respective method.

## Explore how example project works
 
Learn how to setup Python logging by exploring the workings of the [example project](https://github.com/logfire-sh/logfire-python/tree/master/example-project) in detail. 
 
---
 
## Get in touch

Have any questions? Please explore the Logfire [documentation](https://docs.logfire.sh/) or contact our [support](https://support@logfire.sh).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "logfire-python",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "api, logfire, logging, client",
    "author": null,
    "author_email": "Logfire <support@logfire.ai>",
    "download_url": "https://files.pythonhosted.org/packages/94/4e/d6760589cd5542acfd7faa8e4319ed7a0288d7b13ac41f4db54e7f2f0b70/logfire_python-0.0.9.tar.gz",
    "platform": null,
    "description": "# Logfire - Python Logging Made Easy\r\n\r\n\r\n[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)\r\n[![PyPI version](https://badge.fury.io/py/logfire-python.svg)](https://badge.fury.io/py/logfire-python)\r\n\r\n\r\nCollect logs directly from any Python code, including Django.\r\n\r\n[Logfire](https://logfire.sh) is a hosted service that centralizes all of your logs into one place. Allowing for analysis, correlation and filtering with SQL. Actionable dashboards and collaboration come built-in. Logfire works with [any language or platform and any data source](https://docs.logfire.sh/). \r\n\r\n### Features\r\n- Simple integration. Integrates with the Python `logging` library.\r\n- Support for structured logging and events.\r\n- Automatically captures useful context.\r\n- Performant, light weight, with a thoughtful design.\r\n\r\n### Supported language versions\r\n- Python 3.6.5 or newer\r\n- `pip` 20.0.2 or newer\r\n\r\n# Installation\r\nInstall the Logfire Python client library using the `pip` command:\r\n\r\n```bash\r\npip install logfire-python\r\n```\r\n\r\n*Make sure you install the `logfire-python` package and not a different package with the `logfire` keyword in the package name from a different author.*\r\n\r\n---\r\n\r\n# Example project\r\n\r\nTo help you get started with using Logfire in your Python projects, we have prepared a simple Python program that showcases the usage of Logfire logger.\r\n\r\n## Download and install the example project\r\n\r\nYou can download the [example project](https://github.com/logfire-sh/logfire-python/tree/master/example-project) from GitHub directly or you can clone it to a select directory. Then install the `logfire-python` client library as shown before:\r\n\r\n```bash\r\npip install logfire-python\r\n```\r\n\r\n ## Run the example project\r\n \r\n To run the example application, simply run the following command:\r\n\r\n```bash\r\npython main.py <source-token>\r\n```\r\n\r\n*Don't forget to replace `<source-token>` with your actual source token which you can find by going to logfire.com -> sources -> edit.*\r\n\r\n\r\nIf you have trouble running the command above, check your Python installation and try running it with the `python3` command instead. It should give you the following output:\r\n\r\n```\r\nOutput:\r\nAll done! You can check your logs now.\r\n```\r\n\r\nThis example project will create a total of 6 logs. Each corresponding to its respective method.\r\n\r\n## Explore how example project works\r\n \r\nLearn how to setup Python logging by exploring the workings of the [example project](https://github.com/logfire-sh/logfire-python/tree/master/example-project) in detail. \r\n \r\n---\r\n \r\n## Get in touch\r\n\r\nHave any questions? Please explore the Logfire [documentation](https://docs.logfire.sh/) or contact our [support](https://support@logfire.sh).\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Logfire.ai client library",
    "version": "0.0.9",
    "project_urls": {
        "Homepage": "https://github.com/logfire-sh/logfire-python"
    },
    "split_keywords": [
        "api",
        " logfire",
        " logging",
        " client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ab02331b5e9d17303aa14beded8460195fbf8339b9a5d54eb4090e5b4521fc2d",
                "md5": "1fa7047ce362c1fbdf0657578107e01b",
                "sha256": "2261b3f0cabce7d20628213a86068d927a24b45fbd677da931f617854b22d9f3"
            },
            "downloads": -1,
            "filename": "logfire_python-0.0.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1fa7047ce362c1fbdf0657578107e01b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9020,
            "upload_time": "2024-05-23T04:51:02",
            "upload_time_iso_8601": "2024-05-23T04:51:02.350692Z",
            "url": "https://files.pythonhosted.org/packages/ab/02/331b5e9d17303aa14beded8460195fbf8339b9a5d54eb4090e5b4521fc2d/logfire_python-0.0.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "944ed6760589cd5542acfd7faa8e4319ed7a0288d7b13ac41f4db54e7f2f0b70",
                "md5": "82b19cb16fb276e3e86de92f56d73cd3",
                "sha256": "eb53ef88a62de78923c4a8c0a9a4b5b15c239abe533a5d8be40a288093666a0f"
            },
            "downloads": -1,
            "filename": "logfire_python-0.0.9.tar.gz",
            "has_sig": false,
            "md5_digest": "82b19cb16fb276e3e86de92f56d73cd3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13331,
            "upload_time": "2024-05-23T04:51:04",
            "upload_time_iso_8601": "2024-05-23T04:51:04.572762Z",
            "url": "https://files.pythonhosted.org/packages/94/4e/d6760589cd5542acfd7faa8e4319ed7a0288d7b13ac41f4db54e7f2f0b70/logfire_python-0.0.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-23 04:51:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "logfire-sh",
    "github_project": "logfire-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "logfire-python"
}
        
Elapsed time: 4.24698s