Metadata-Version: 2.1
Name: django-log-reader
Version: 1.0.0
Summary: Read & Download log files on the admin page
Home-page: https://github.com/imankarimi/django-log-reader
Author: Iman Karimi
Author-email: imankarimi.mail@gmail.com
License: MIT License
Description: # Django Log Reader
        **Django Log Reader** allows you to read &amp; download log files on the admin page.
        
        > This version designed for the Linux operating system and uses Linux commands to read files faster.
        
        <br />
        
        ## Why Django Log Reader?
        
        - Reading files based on Linux commands speeds up the display of file content
        - Download the result of the content
        - Display all files according to the pattern defined in the `settings.py`
        - Simple interface
        - Easy integration
        
        <br />
        
        ![Django Log Reader](https://raw.githubusercontent.com/imankarimi/django-log-reader/main/screenshots/django_log_reader.png)
        
        
        <br>
        
        ## How to use it
        
        <br />
        
        * Download and install latest version of Django Log Reader:
        
        ```bash
        $ pip install django-log-reader
        # or
        $ easy_install django-log-reader
        ```
        
        <br />
        
        * Add `log_reader` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file:
        
        ```python
        INSTALLED_APPS = (
        # ...
        "log_reader.apps.LogReaderConfig",
        )
        ```
        
        <br />
        
        * You can Add the following value In your `settings.py` file:
        
        ```python
        # This value specifies the folder for the files. The default value is 'logs'
        LOG_READER_DIR_PATH = 'logs'
        
        # This value specifies the file extensions. The default value is '*.log'
        LOG_READER_FILES_PATTERN = '*.log'
        
        # This value specifies the default file. If there is no filter, the system reads the default file.
        LOG_READER_DEFAULT_FILE = 'django.log'
        
        # The contents of the files are separated based on this pattern.
        LOG_READER_SPLIT_PATTERN = "\\n"
        
        # This value indicates the number of lines of content in the file. Set the number of lines you want to read to this value.
        LOG_READER_MAX_READ_LINES = 1000
        ```
        
        <br />
        
        * Collect static if you are in production environment:
        ```bash
        $ python manage.py collectstatic
        ```
        
        * Clear your browser cache
        
        <br />
        
        ## Start the app
        
        ```bash
        # Set up the database
        $ python manage.py makemigrations
        $ python manage.py migrate
        
        # Create the superuser
        $ python manage.py createsuperuser
        
        # Start the application (development mode)
        $ python manage.py runserver # default port 8000
        ```
        
        * Access the `admin` section in the browser: `http://127.0.0.1:8000/`
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Environment :: Web Environment
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
