macos-oslog


Namemacos-oslog JSON
Version 0.5.0 PyPI version JSON
download
home_pagehttps://github.com/andy-maier/macos-oslog
SummaryPython bindings for the unified logging and tracing system of macOS
upload_time2022-09-04 23:18:23
maintainerAndreas Maier
docs_urlNone
authorAndreas Maier
requires_python>=3.5
licenseApache Software License 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            macos-oslog - Python bindings for the unified logging and tracing system of macOS
=================================================================================

.. image:: https://badge.fury.io/py/macos-oslog.svg
    :target: https://pypi.python.org/pypi/macos-oslog/
    :alt: Version on Pypi

.. image:: https://github.com/andy-maier/macos-oslog/workflows/test/badge.svg?branch=master
    :target: https://github.com/andy-maier/macos-oslog/actions/
    :alt: Test status (master)

.. image:: https://github.com/andy-maier/macos-oslog/workflows/docs/badge.svg?branch=master
    :target: https://github.com/andy-maier/macos-oslog/actions?query=workflow%3Adocs
    :alt: Docs build status (master)

.. # .. image:: https://coveralls.io/repos/github/andy-maier/macos-oslog/badge.svg?branch=master
.. #     :target: https://coveralls.io/github/andy-maier/macos-oslog?branch=master
.. #     :alt: Test coverage (master)


Overview
--------

This package is only for macOS and requires macOS 10.12 or higher.

Its purpose is to insert log messages into the unified logging and tracing system
of macOS. It does not support reading the unified log.


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

To install the latest released version of the macos_oslog
package into your active Python environment:

.. code-block:: bash

    $ pip install macos-oslog

This will also install any prerequisite Python packages.

For more details and alternative ways to install, see
`Installation`_.

.. _Installation: https://andy-maier.github.io/macos-oslog/html/docs/install.html#installation

Documentation
-------------

* `Documentation for latest released version <https://andy-maier.github.io/macos-oslog/html/docs/>`_

Change History
--------------

* `Change history for latest released version <https://andy-maier.github.io/macos-oslog/html/docs/changes.html>`_

Quick Start
-----------

Example Python code:

.. code-block:: python

    #!/usr/bin/env python
    import macos_oslog

    log = macos_oslog.os_log_create(subsystem="com.acme.myapp", category="all")
    macos_oslog.os_log(log, macos_oslog.OS_LOG_TYPE_ERROR, "Some error happened")
    macos_oslog.os_log_release(log)

Example Python code using the predefined standard log provided by macOS:

.. code-block:: python

    #!/usr/bin/env python
    import macos_oslog

    macos_oslog.os_log(macos_oslog.OS_LOG_DEFAULT, macos_oslog.OS_LOG_TYPE_ERROR, "Some error happened")


Contributing
------------

For information on how to contribute to the
macos-oslog project, see
`Contributing <https://andy-maier.github.io/macos-oslog/html/docs/development.html#contributing>`_.


License
-------

The macos-oslog project is provided under the
`Apache Software License 2.0 <https://raw.githubusercontent.com/andy-maier/macos-oslog/master/LICENSE>`_.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/andy-maier/macos-oslog",
    "name": "macos-oslog",
    "maintainer": "Andreas Maier",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "andreas.r.maier@gmx.de",
    "keywords": "",
    "author": "Andreas Maier",
    "author_email": "andreas.r.maier@gmx.de",
    "download_url": "https://files.pythonhosted.org/packages/c5/f6/33301b3c5c45f1a8c5872f0970b46862344872f788a1e8e9236847395350/macos-oslog-0.5.0.tar.gz",
    "platform": "Darwin",
    "description": "macos-oslog - Python bindings for the unified logging and tracing system of macOS\n=================================================================================\n\n.. image:: https://badge.fury.io/py/macos-oslog.svg\n    :target: https://pypi.python.org/pypi/macos-oslog/\n    :alt: Version on Pypi\n\n.. image:: https://github.com/andy-maier/macos-oslog/workflows/test/badge.svg?branch=master\n    :target: https://github.com/andy-maier/macos-oslog/actions/\n    :alt: Test status (master)\n\n.. image:: https://github.com/andy-maier/macos-oslog/workflows/docs/badge.svg?branch=master\n    :target: https://github.com/andy-maier/macos-oslog/actions?query=workflow%3Adocs\n    :alt: Docs build status (master)\n\n.. # .. image:: https://coveralls.io/repos/github/andy-maier/macos-oslog/badge.svg?branch=master\n.. #     :target: https://coveralls.io/github/andy-maier/macos-oslog?branch=master\n.. #     :alt: Test coverage (master)\n\n\nOverview\n--------\n\nThis package is only for macOS and requires macOS 10.12 or higher.\n\nIts purpose is to insert log messages into the unified logging and tracing system\nof macOS. It does not support reading the unified log.\n\n\nInstallation\n------------\n\nTo install the latest released version of the macos_oslog\npackage into your active Python environment:\n\n.. code-block:: bash\n\n    $ pip install macos-oslog\n\nThis will also install any prerequisite Python packages.\n\nFor more details and alternative ways to install, see\n`Installation`_.\n\n.. _Installation: https://andy-maier.github.io/macos-oslog/html/docs/install.html#installation\n\nDocumentation\n-------------\n\n* `Documentation for latest released version <https://andy-maier.github.io/macos-oslog/html/docs/>`_\n\nChange History\n--------------\n\n* `Change history for latest released version <https://andy-maier.github.io/macos-oslog/html/docs/changes.html>`_\n\nQuick Start\n-----------\n\nExample Python code:\n\n.. code-block:: python\n\n    #!/usr/bin/env python\n    import macos_oslog\n\n    log = macos_oslog.os_log_create(subsystem=\"com.acme.myapp\", category=\"all\")\n    macos_oslog.os_log(log, macos_oslog.OS_LOG_TYPE_ERROR, \"Some error happened\")\n    macos_oslog.os_log_release(log)\n\nExample Python code using the predefined standard log provided by macOS:\n\n.. code-block:: python\n\n    #!/usr/bin/env python\n    import macos_oslog\n\n    macos_oslog.os_log(macos_oslog.OS_LOG_DEFAULT, macos_oslog.OS_LOG_TYPE_ERROR, \"Some error happened\")\n\n\nContributing\n------------\n\nFor information on how to contribute to the\nmacos-oslog project, see\n`Contributing <https://andy-maier.github.io/macos-oslog/html/docs/development.html#contributing>`_.\n\n\nLicense\n-------\n\nThe macos-oslog project is provided under the\n`Apache Software License 2.0 <https://raw.githubusercontent.com/andy-maier/macos-oslog/master/LICENSE>`_.\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "Python bindings for the unified logging and tracing system of macOS",
    "version": "0.5.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/andy-maier/macos-oslog/issues",
        "Documentation": "https://andy-maier.github.io/macos-oslog/html/docs/",
        "Homepage": "https://github.com/andy-maier/macos-oslog",
        "Source Code": "https://github.com/andy-maier/macos-oslog"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c5f633301b3c5c45f1a8c5872f0970b46862344872f788a1e8e9236847395350",
                "md5": "08d4bf21eff7120fb215f0eaf5134fd9",
                "sha256": "5aabc9953f50dcde7a8b77225ca940a18f4ceaa107d0ef36ba3ac50662ec4c71"
            },
            "downloads": -1,
            "filename": "macos-oslog-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "08d4bf21eff7120fb215f0eaf5134fd9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 12547,
            "upload_time": "2022-09-04T23:18:23",
            "upload_time_iso_8601": "2022-09-04T23:18:23.032417Z",
            "url": "https://files.pythonhosted.org/packages/c5/f6/33301b3c5c45f1a8c5872f0970b46862344872f788a1e8e9236847395350/macos-oslog-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-09-04 23:18:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "andy-maier",
    "github_project": "macos-oslog",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "macos-oslog"
}
        
Elapsed time: 0.31578s