logfire-python


Namelogfire-python JSON
Version 0.0.8 PyPI version JSON
download
home_page
SummaryLogfire.ai client library
upload_time2023-07-28 07:27:04
maintainer
docs_urlNone
author
requires_python
license
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.ai) 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.ai/). 

### 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.ai/) or contact our [support](https://support@logfire.ai).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "logfire-python",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "api,logfire,logging,client",
    "author": "",
    "author_email": "Logfire <support@logfire.ai>",
    "download_url": "https://files.pythonhosted.org/packages/06/41/896109405073cbe5766562bd6daa7feed962bb8e17fe62a87050aad394b7/logfire-python-0.0.8.tar.gz",
    "platform": null,
    "description": "# Logfire - Python Logging Made Easy\n\n\n[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)\n[![PyPI version](https://badge.fury.io/py/logfire-python.svg)](https://badge.fury.io/py/logfire-python)\n\n\nCollect logs directly from any Python code, including Django.\n\n[Logfire](https://logfire.ai) 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.ai/). \n\n### Features\n- Simple integration. Integrates with the Python `logging` library.\n- Support for structured logging and events.\n- Automatically captures useful context.\n- Performant, light weight, with a thoughtful design.\n\n### Supported language versions\n- Python 3.6.5 or newer\n- `pip` 20.0.2 or newer\n\n# Installation\nInstall the Logfire Python client library using the `pip` command:\n\n```bash\npip install logfire-python\n```\n\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.*\n\n---\n\n# Example project\n\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.\n\n## Download and install the example project\n\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:\n\n```bash\npip install logfire-python\n```\n\n ## Run the example project\n \n To run the example application, simply run the following command:\n\n```bash\npython main.py <source-token>\n```\n\n*Don't forget to replace `<source-token>` with your actual source token which you can find by going to logfire.com -> sources -> edit.*\n\n\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:\n\n```\nOutput:\nAll done! You can check your logs now.\n```\n\nThis example project will create a total of 6 logs. Each corresponding to its respective method.\n\n## Explore how example project works\n \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. \n \n---\n \n## Get in touch\n\nHave any questions? Please explore the Logfire [documentation](https://docs.ai/) or contact our [support](https://support@logfire.ai).\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Logfire.ai client library",
    "version": "0.0.8",
    "project_urls": {
        "Homepage": "https://github.com/logfire-sh/logfire-python"
    },
    "split_keywords": [
        "api",
        "logfire",
        "logging",
        "client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5249390ff252bbf022d52b771f6b99ea43df0444bdd2a861efd23475c4a9115a",
                "md5": "6b67d7a2502eaf99e9e295d36320dd2c",
                "sha256": "2ba69e73ad02974db3bfff8c828725393faf3a861e3c8105b74ffc871dfa375d"
            },
            "downloads": -1,
            "filename": "logfire_python-0.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6b67d7a2502eaf99e9e295d36320dd2c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8917,
            "upload_time": "2023-07-28T07:27:02",
            "upload_time_iso_8601": "2023-07-28T07:27:02.072563Z",
            "url": "https://files.pythonhosted.org/packages/52/49/390ff252bbf022d52b771f6b99ea43df0444bdd2a861efd23475c4a9115a/logfire_python-0.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0641896109405073cbe5766562bd6daa7feed962bb8e17fe62a87050aad394b7",
                "md5": "36f192671f5790a7543065240c2031c3",
                "sha256": "2c6856bdaac705c8114a881290cc58ebfb427fac772b490f5bad87be253d3853"
            },
            "downloads": -1,
            "filename": "logfire-python-0.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "36f192671f5790a7543065240c2031c3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13060,
            "upload_time": "2023-07-28T07:27:04",
            "upload_time_iso_8601": "2023-07-28T07:27:04.112523Z",
            "url": "https://files.pythonhosted.org/packages/06/41/896109405073cbe5766562bd6daa7feed962bb8e17fe62a87050aad394b7/logfire-python-0.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-28 07:27: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: 0.10920s