{ "info": { "author": "Alexander Oblovatniy", "author_email": "oblovatniy@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)", "Natural Language :: English", "Operating System :: Microsoft :: Windows", "Operating System :: Unix", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Libraries" ], "description": "IL-2 FB Game Log Parser\n=======================\n\n|pypi_package| |python_versions| |license|\n\n|unix_build| |windows_build| |coverage_status|\n\n|codacy| |quality| |health| |requirements|\n\n\n**Table of contents**\n\n.. contents::\n :local:\n :depth: 1\n :backlinks: none\n\n\nSynopsis\n--------\n\nThis is a Python library which parses events from game log produced by\ndedicated server of \u00abIL-2 Forgotten Battles\u00bb flight simulator. Resulting\ninformation about events is stored in special data structures.\n\n\nDemo\n----\n\nYou may see this library in action even if you do not understand its purpose.\n\nAll you need is just to `visit project's demo page`_.\n\nThat page allows you to test parser's ability to process strings. If you\ndo not know what to enter into a text area, you may click ``Insert test data``\nand parse it.\n\nIf something goes wrong, you will be prompted to confirm automatic creation of\nbug report which will be\n`listed on this page `_.\n\n\nKnown events\n------------\n\nThis library supports all known events produced by dedicated server\n(129 unique events).\n\nTo see their list, go to the `demo page`_ and click\n``See the list of supported events`` link.\n\n\nInstallation\n------------\n\nGet Python package from PyPI:\n\n.. code-block:: bash\n\n pip install il2fb-game-log-parser\n\n\nUsage\n-----\n\nIf you need to be able to parse all events this library knows about, use\n``GameLogEventParser.parse_string()``:\n\nImport ``GameLogEventParser`` and create its instance:\n\n.. code-block:: python\n\n from il2fb.parsers.game_log import GameLogEventParser\n\n parser = GameLogEventParser()\n\n\nParse a string to get an instance of event:\n\n.. code-block:: python\n\n event = parser.parse(\"[8:33:05 PM] User0 has connected\")\n\n\nExplore event's internal structure:\n\n.. code-block:: python\n\n print(event)\n # \n\n print(event.time)\n # datetime.time(20, 33, 5)\n\n print(event.actor)\n # \n\n print(event.actor.callsign)\n # User0\n\n\nConvert event into a dictionary:\n\n.. code-block:: python\n\n import pprint\n\n pprint.pprint(event.to_primitive())\n # {'actor': {'callsign': 'User0'},\n # 'name': 'HumanHasConnected',\n # 'time': '20:33:05',\n # 'verbose_name': 'Human has connected'}\n\n\nExceptions\n----------\n\nIf you try to parse unknown event, ``EventParsingException`` will be raised:\n\n.. code-block:: python\n\n parser.parse(\"foo bar\")\n # Traceback (most recent call last):\n # \u2026\n # EventParsingException: No event was found for string \"foo bar\"\n\nCurrent list of supported events is rather full, but ``EventParsingException``\nis quite possible, because server's events are undocumented and this library\nmay do not know about all of them.\n\nIn case you need to catch this error, its full name is\n``il2fb.commons.events.EventParsingException``.\n\n\nSafe usage\n----------\n\nYou can set flag ``ignore_errors=True`` if you don't care about any exceptions:\n\n.. code-block:: python\n\n from il2fb.parsers.game_log import GameLogEventParser\n\n parser = GameLogEventParser()\n event = parser.parse(\"foo bar\", ignore_errors=True)\n print(event is None)\n # True\n\nAny error (except ``SystemExit`` and ``KeyboardInterrupt``) will be muted and\n``None`` will be returned.\n\n\n.. |unix_build| image:: https://travis-ci.org/IL2HorusTeam/il2fb-game-log-parser.svg?branch=master\n :target: https://travis-ci.org/IL2HorusTeam/il2fb-game-log-parser\n\n.. |windows_build| image:: https://ci.appveyor.com/api/projects/status/a47k677tr59bd5wg/branch/master?svg=true\n :target: https://ci.appveyor.com/project/oblalex/il2fb-events-parser\n :alt: Build status of the master branch on Windows\n\n.. |coverage_status| image:: http://codecov.io/github/IL2HorusTeam/il2fb-game-log-parser/coverage.svg?branch=master\n :target: http://codecov.io/github/IL2HorusTeam/il2fb-game-log-parser?branch=master\n :alt: Test coverage\n\n.. |codacy| image:: https://api.codacy.com/project/badge/c0385f01ffa545dea3a52a51cfc53221\n :target: https://www.codacy.com/app/oblalex/il2fb-game-log-parser\n :alt: Codacy Code Review\n\n.. |quality| image:: https://scrutinizer-ci.com/g/IL2HorusTeam/il2fb-game-log-parser/badges/quality-score.png?b=master\n :target: https://scrutinizer-ci.com/g/IL2HorusTeam/il2fb-game-log-parser/?branch=master\n :alt: Scrutinizer Code Quality\n\n.. |health| image:: https://landscape.io/github/IL2HorusTeam/il2fb-game-log-parser/master/landscape.svg?style=flat\n :target: https://landscape.io/github/IL2HorusTeam/il2fb-game-log-parser/master\n :alt: Code Health\n\n.. |pypi_package| image:: http://img.shields.io/pypi/v/il2fb-game-log-parser.svg?style=flat\n :target: http://badge.fury.io/py/il2fb-game-log-parser/\n\n.. |python_versions| image:: https://img.shields.io/badge/Python-2.7,3.4,3.5,3.6-brightgreen.svg?style=flat\n :alt: Supported versions of Python\n\n.. |license| image:: https://img.shields.io/badge/license-LGPLv3-blue.svg?style=flat\n :target: https://github.com/IL2HorusTeam/il2fb-game-log-parser/blob/master/LICENSE\n\n.. |requirements| image:: https://requires.io/github/IL2HorusTeam/il2fb-game-log-parser/requirements.svg?branch=master\n :target: https://requires.io/github/IL2HorusTeam/il2fb-game-log-parser/requirements/?branch=master\n :alt: Requirements Status\n\n\n.. _demo page: http://il2horusteam.github.io/il2fb-game-log-parser/\n.. _visit project's demo page: `demo page`_", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/IL2HorusTeam/il2fb-game-log-parser", "keywords": "il2,il-2,fb,forgotten battles,parser,events,server,game,log", "license": "LGPLv3", "maintainer": "", "maintainer_email": "", "name": "il2fb-game-log-parser", "package_url": "https://pypi.org/project/il2fb-game-log-parser/", "platform": "", "project_url": "https://pypi.org/project/il2fb-game-log-parser/", "project_urls": { "Homepage": "https://github.com/IL2HorusTeam/il2fb-game-log-parser" }, "release_url": "https://pypi.org/project/il2fb-game-log-parser/1.0.3/", "requires_dist": null, "requires_python": "", "summary": "Parse events from game log produced by dedicated server of \u00abIL-2 Forgotten Battles\u00bb flight simulator", "version": "1.0.3" }, "last_serial": 3390678, "releases": { "1.0.2": [ { "comment_text": "", "digests": { "md5": "844eccc2817799212ffc8d5c0f028821", "sha256": "e343bdb53d0da714cd09e94165357db767828cf898d5d2849bcd07e33b18e0f6" }, "downloads": -1, "filename": "il2fb-game-log-parser-1.0.2.tar.gz", "has_sig": false, "md5_digest": "844eccc2817799212ffc8d5c0f028821", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22610, "upload_time": "2017-10-16T17:57:10", "url": "https://files.pythonhosted.org/packages/0a/86/36ca5878e2e3176c37c3b2aa835d36135d2179686c9d2f1070e131c2b572/il2fb-game-log-parser-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "d56d7c174ab799c5302e03af55dbcf85", "sha256": "be88be7c2f1277994e5c3ec7fc146932c50734b8ff78dfd73974e06af60cde32" }, "downloads": -1, "filename": "il2fb-game-log-parser-1.0.3.tar.gz", "has_sig": false, "md5_digest": "d56d7c174ab799c5302e03af55dbcf85", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22591, "upload_time": "2017-12-05T14:07:41", "url": "https://files.pythonhosted.org/packages/60/5b/9d3bd971c9644b7011dbbe9f9541b808c246ee50af5d9317308a66829356/il2fb-game-log-parser-1.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d56d7c174ab799c5302e03af55dbcf85", "sha256": "be88be7c2f1277994e5c3ec7fc146932c50734b8ff78dfd73974e06af60cde32" }, "downloads": -1, "filename": "il2fb-game-log-parser-1.0.3.tar.gz", "has_sig": false, "md5_digest": "d56d7c174ab799c5302e03af55dbcf85", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22591, "upload_time": "2017-12-05T14:07:41", "url": "https://files.pythonhosted.org/packages/60/5b/9d3bd971c9644b7011dbbe9f9541b808c246ee50af5d9317308a66829356/il2fb-game-log-parser-1.0.3.tar.gz" } ] }