# TextLogCheck
A Python package for analyzing, verifying, and monitoring text-based log files.
Includes tools for file existence checks, log tail analysis, text searches, and more.
You can find **Full Project Documentation** [here][documentation_path]
<hr>
#### Workflows
[](https://github.com/LibSecSource/text-log-check/actions/workflows/run-tests.yml)
[](https://github.com/LibSecSource/text-log-check/actions/workflows/lint.yml)
#### Package
[](https://pypi.python.org/pypi/text-log-check/)
[](https://pypi.python.org/pypi/text-log-check)
[](https://pypi.python.org/pypi/text-log-check/)
[](https://github.com/LibSecSource/text-log-check/blob/main/LICENSE)
[](https://pypi.python.org/pypi/text-log-check/)
#### Support
[][documentation_path]
[](https://github.com/LibSecSource/text-log-check/discussions/)
[](https://github.com/LibSecSource/text-log-check/issues/)
#### Downloads
[](https://pepy.tech/project/text-log-check)
[](https://pepy.tech/project/text-log-check)
[](https://pepy.tech/project/text-log-check)
[](https://pepy.tech/project/text-log-check)
#### Languages
[](https://github.com/LibSecSource/text-log-check)
[](https://github.com/LibSecSource/text-log-check)
#### Development
- [](https://github.com/LibSecSource/text-log-check/releases)
[](https://github.com/LibSecSource/text-log-check)
- [](https://github.com/LibSecSource/text-log-check/issues/)
[](https://github.com/LibSecSource/text-log-check/issues/)
- [](https://github.com/LibSecSource/text-log-check/pulls)
[](https://github.com/LibSecSource/text-log-check/pulls)
- [](https://github.com/LibSecSource/text-log-check/discussions/)
[//]: # (#### Repository Stats)
[//]: # ([
[//]: # ()](https://github.com/LibSecSource/text-log-check))
[//]: # ([
[//]: # ()](https://github.com/LibSecSource/text-log-checkgraphs/contributors))
[//]: # ([
[//]: # ()](https://github.com/LibSecSource/text-log-check))
<hr>
## Menu
- [Mission](#mission)
- [Open Source Project](#open-source-project)
- [Features](#features)
- [Requirements](#requirements)
- [Development Status](#development-status)
- [Install](#install)
- [Quickstart](#quickstart)
- [Contributing](#contributing)
## Mission
To provide a reliable, open-source Python solution for managing and analyzing text-based log files,
empowering developers, system administrators, and security professionals with tools to
ensure log integrity, streamline troubleshooting, and enhance system monitoring practices.
## Open Source Project
This is the open source project with [Happy Code](LICENSE) license.
Be free to use, fork, clone and contribute.
## Features
- Check if log file exists
- Read tail of log file
- Clear log file
- Check if user can change log file
- Check if user can delete log file (Plan)
- Search text in log file (Plan)
- Modify log file (Plan)
## Requirements
- python >= 3
- See more in [Full Documentation](https://libsecsource.github.io/text-log-check/about.html#requirements)
## Development Status
- Package already available on [PyPi](https://pypi.org/project/text-log-check/)
- See more in [Full Documentation](https://libsecsource.github.io/text-log-check/about.html#development-status)
## Install
### with pip
```commandline
pip install text-log-check
```
See more in [Full Documentation](https://libsecsource.github.io/text-log-check/install.html)
## Quickstart
```python
from text_log_check import exists, tail, clear, is_modifiable
if exists('/var/log/auth.log'):
print(tail('var/log/auth.log', 5))
if is_modifiable('var/log/auth.log'):
clear('var/log/auth.log')
```
### More examples in [Full Documentation][documentation_path]
## Contributing
You are welcome! To easy start please check:
- [Full Documentation][documentation_path]
- [Contributing](CONTRIBUTING.md)
- [Developer Documentation](https://libsecsource.github.io/text-log-check/dev_documentation.html)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Security Policy](SECURITY.md)
- [Governance](GOVERNANCE.md)
- [Support](SUPPORT.md)
[documentation_path]: https://libsecsource.github.io/text-log-check/
Raw data
{
"_id": null,
"home_page": "https://github.com/LibSecSource/text-log-check",
"name": "text-log-check",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "python, security, log-analysis",
"author": "quillcraftsman",
"author_email": "quill@craftsman.lol",
"download_url": "https://files.pythonhosted.org/packages/5f/46/e665a6053e0f9f10af783b2295d5b830ee013399fd4427a4d9a853679313/text_log_check-0.1.0.tar.gz",
"platform": null,
"description": "# TextLogCheck\n\nA Python package for analyzing, verifying, and monitoring text-based log files. \nIncludes tools for file existence checks, log tail analysis, text searches, and more. \n\nYou can find **Full Project Documentation** [here][documentation_path]\n\n<hr>\n\n#### Workflows\n[](https://github.com/LibSecSource/text-log-check/actions/workflows/run-tests.yml)\n[](https://github.com/LibSecSource/text-log-check/actions/workflows/lint.yml)\n\n#### Package\n[](https://pypi.python.org/pypi/text-log-check/)\n[](https://pypi.python.org/pypi/text-log-check)\n[](https://pypi.python.org/pypi/text-log-check/)\n[](https://github.com/LibSecSource/text-log-check/blob/main/LICENSE)\n[](https://pypi.python.org/pypi/text-log-check/)\n\n#### Support\n[][documentation_path]\n[](https://github.com/LibSecSource/text-log-check/discussions/)\n[](https://github.com/LibSecSource/text-log-check/issues/)\n\n#### Downloads\n[](https://pepy.tech/project/text-log-check)\n[](https://pepy.tech/project/text-log-check)\n[](https://pepy.tech/project/text-log-check)\n[](https://pepy.tech/project/text-log-check)\n\n#### Languages\n[](https://github.com/LibSecSource/text-log-check)\n[](https://github.com/LibSecSource/text-log-check)\n\n#### Development\n- [](https://github.com/LibSecSource/text-log-check/releases)\n[](https://github.com/LibSecSource/text-log-check)\n- [](https://github.com/LibSecSource/text-log-check/issues/)\n[](https://github.com/LibSecSource/text-log-check/issues/)\n- [](https://github.com/LibSecSource/text-log-check/pulls)\n[](https://github.com/LibSecSource/text-log-check/pulls)\n- [](https://github.com/LibSecSource/text-log-check/discussions/)\n\n[//]: # (#### Repository Stats)\n\n[//]: # ([\n\n[//]: # ()](https://github.com/LibSecSource/text-log-check))\n\n[//]: # ([\n\n[//]: # ()](https://github.com/LibSecSource/text-log-checkgraphs/contributors))\n\n[//]: # ([\n\n[//]: # ()](https://github.com/LibSecSource/text-log-check))\n\n<hr>\n\n## Menu\n\n- [Mission](#mission)\n- [Open Source Project](#open-source-project)\n- [Features](#features)\n- [Requirements](#requirements)\n- [Development Status](#development-status)\n- [Install](#install)\n- [Quickstart](#quickstart)\n- [Contributing](#contributing)\n\n## Mission\n\nTo provide a reliable, open-source Python solution for managing and analyzing text-based log files, \nempowering developers, system administrators, and security professionals with tools to \nensure log integrity, streamline troubleshooting, and enhance system monitoring practices.\n\n## Open Source Project\n\nThis is the open source project with [Happy Code](LICENSE) license.\nBe free to use, fork, clone and contribute.\n\n## Features\n\n- Check if log file exists\n- Read tail of log file\n- Clear log file\n- Check if user can change log file\n- Check if user can delete log file (Plan)\n- Search text in log file (Plan)\n- Modify log file (Plan)\n\n\n## Requirements\n\n- python >= 3\n- See more in [Full Documentation](https://libsecsource.github.io/text-log-check/about.html#requirements)\n\n## Development Status\n\n- Package already available on [PyPi](https://pypi.org/project/text-log-check/)\n- See more in [Full Documentation](https://libsecsource.github.io/text-log-check/about.html#development-status)\n\n## Install\n\n### with pip\n\n```commandline\npip install text-log-check\n```\n\nSee more in [Full Documentation](https://libsecsource.github.io/text-log-check/install.html)\n\n## Quickstart\n\n```python\nfrom text_log_check import exists, tail, clear, is_modifiable\n\nif exists('/var/log/auth.log'):\n print(tail('var/log/auth.log', 5))\n if is_modifiable('var/log/auth.log'):\n clear('var/log/auth.log')\n```\n\n### More examples in [Full Documentation][documentation_path]\n\n## Contributing\n\nYou are welcome! To easy start please check:\n- [Full Documentation][documentation_path]\n- [Contributing](CONTRIBUTING.md)\n- [Developer Documentation](https://libsecsource.github.io/text-log-check/dev_documentation.html)\n- [Code of Conduct](CODE_OF_CONDUCT.md)\n- [Security Policy](SECURITY.md)\n- [Governance](GOVERNANCE.md)\n- [Support](SUPPORT.md)\n\n[documentation_path]: https://libsecsource.github.io/text-log-check/\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for analyzing, verifying, and monitoring text-based log files. Includes tools for file existence checks, log tail analysis, text searches, and more.",
"version": "0.1.0",
"project_urls": {
"Changelog": "https://github.com/LibSecSource/text-log-check/releases",
"Documentation": "https://libsecsource.github.io/text-log-check/",
"Download": "https://pypi.org/project/pygenesis/",
"Homepage": "https://github.com/LibSecSource/text-log-check",
"Release notes": "https://github.com/LibSecSource/text-log-check/releases",
"Source": "https://github.com/LibSecSource/text-log-check",
"Tracker": "https://github.com/LibSecSource/text-log-check/issues"
},
"split_keywords": [
"python",
" security",
" log-analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "201c3579910d3cc697d88c4fc3d36d266d899775fd129e556b4b40f78649cce3",
"md5": "93a5c55d33e3f7cef8dc9e7893d67c78",
"sha256": "05a29c09bb83811009cf154c2d7a567a76ae87086f6c991e052a88fc640c8853"
},
"downloads": -1,
"filename": "text_log_check-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93a5c55d33e3f7cef8dc9e7893d67c78",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 4619,
"upload_time": "2024-12-10T09:08:45",
"upload_time_iso_8601": "2024-12-10T09:08:45.927124Z",
"url": "https://files.pythonhosted.org/packages/20/1c/3579910d3cc697d88c4fc3d36d266d899775fd129e556b4b40f78649cce3/text_log_check-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f46e665a6053e0f9f10af783b2295d5b830ee013399fd4427a4d9a853679313",
"md5": "a0827595da2672a8eab283c471bbb8c5",
"sha256": "e494c7f388bfa9a8afb1f461dfd4d83bb818d810005bde944b031dd9b50bc07a"
},
"downloads": -1,
"filename": "text_log_check-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "a0827595da2672a8eab283c471bbb8c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 5057,
"upload_time": "2024-12-10T09:08:48",
"upload_time_iso_8601": "2024-12-10T09:08:48.104888Z",
"url": "https://files.pythonhosted.org/packages/5f/46/e665a6053e0f9f10af783b2295d5b830ee013399fd4427a4d9a853679313/text_log_check-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 09:08:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LibSecSource",
"github_project": "text-log-check",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "wheel",
"specs": []
},
{
"name": "setuptools",
"specs": []
}
],
"lcname": "text-log-check"
}
JSON
