Metadata-Version: 2.1
Name: rknfind
Version: 2.1.0a1
Summary: Dig into RKN dump with ease
Home-page: https://github.com/scpketer/rknfind
Author: scpketer
Author-email: scpketer@protonmail.ch
License: UNKNOWN
Description: # RknFind project
        
        ## Disclaimer
        
        This application provides tools for browsing and exporting
        RKN (RosKomNadzor, a Russian communications managing autority)
        dump of sites blocked in Russia.
        
        Please note that visiting sites exposed from RKN dump by
        this application may be illegal in some countries.
        
        End user takes full responsibility for any actions made using this application,
        which include, but not limited by:
        
        -   Downloading a copy of RKN dump file from Zapret-Info Github repository
        -   Retrieving a human-readable list of blocked sites/URLs/IP addresses
        -   Exporting list of blocked resources to SQLite database
        
        ## Features
        
        What can this application do?
        
        -   Retrieve and auto-update RKN dump file
        -   Process RKN dump file and print out human-readable/JSON-formatted list of
            blocked sites
        -   Export list of blocked sites to SQLite database
        
        ## Usage
        ### Installation
        Application is available at PyPI and can be retrieved using `pip`:
        
        ```bash
        $ pip install rknfind
        ```
        
        You can install `git` and `gitpython` module to slightly improve performance
        on dump file download:
        -   Git downloads - https://git-scm.com/downloads
        -   GitPython installation:
            ```bash
            $ pip install rknfind[git]
            ```
        
        You can also install `peewee` to be able to export data into SQLite database:
        ```bash
        $ pip install rknfind[db]
        ```
        
        ### Launching
        Once you've installed `rknfind`, just run it in terminal:
        ```bash
        $ rknfind
        ```
        
        With no filter parameters provided, `rknfind` will exit. Use `rknfind -f <field> <occurence>` to add filter. You can use `-f` flag multiple times!
        
        List of fields:
        | Field    | Description                   |
        |----------|-------------------------------|
        | `addr`   | List of IP addresses of entry |
        | `date`   | Issue date of entry           |
        | `decree` | Decree of entry               |
        | `issuer` | Issuing authority of entry    |
        | `domain` | List of domain names of entry |
        | `url`    | List of URLs of entry         |
        
        For info related to other flags, use `rknfind -h`
        
Keywords: rkn roskomnadzor cli find
Platform: UNKNOWN
Requires-Python: >=3, <4
Description-Content-Type: text/markdown
Provides-Extra: db
Provides-Extra: git
