Metadata-Version: 1.0
Name: ovipositor
Version: 2017.2.5.157
Summary: link-shortening website and database system
Home-page: https://github.com/wdbm/ovipositor
Author: Will Breaden Madden
Author-email: wbm@protonmail.ch
License: GPLv3
Description: ovipositor
        ==========
        
        Flask link-shortening service and database system
        
        .. figure:: ovipositor.png
           :alt: 
        
        credits
        =======
        
        -  name by Ellis Kay
        
        introduction
        ============
        
        Ovipositor is a link-shortener web program. A long URL is entered,
        together with an optional shortlink and an optional comment. When
        creating a shortlink, the long URL and the shortlink are saved to a
        database. When an attempt is made to use a shortlink, the specified
        shortlink is searched for in the database and, if the shortlink is in
        the database, there is a redirect to its corresponding long URL.
        
        setup
        =====
        
        .. code:: bash
        
            sudo pip install ovipositor
        
        usage
        =====
        
        .. code:: bash
        
            ./ovipositor.py
        
        ovipositor database structure
        =============================
        
        There is one table in an ovipositor database called "shortlinks". This
        table has 6 fields:
        
        +-------------------+-----------------------------------------------+
        | **table field**   | **description**                               |
        +===================+===============================================+
        | comment           | shortlink descriptive comment                 |
        +-------------------+-----------------------------------------------+
        | count             | shortlink usage count                         |
        +-------------------+-----------------------------------------------+
        | IP                | IP address that created the shortlink         |
        +-------------------+-----------------------------------------------+
        | URL               | long URL to which the shortlink corresponds   |
        +-------------------+-----------------------------------------------+
        | shortlink         | shortlink text                                |
        +-------------------+-----------------------------------------------+
        | timestamp         | shortlink creation timestamp                  |
        +-------------------+-----------------------------------------------+
        
        examining databases
        ===================
        
        A database can be examined using
        `datavision <https://github.com/wdbm/datavision>`__
        `view\_database\_SQLite.py <https://github.com/wdbm/datavision/blob/master/view_database_SQLite.py>`__.
        
        changing from YOURLS to ovipositor
        ==================================
        
        An export dump should be made of the YOURLS MySQL database and the dump
        should be converted to an SQLite3 database. This can be done using
        `mysql2sqlite <https://github.com/dumblob/mysql2sqlite>`__.
        
        The YOURLS SQLite database then can be converted to an ovipositor
        database using the script
        ``convert_YOURLS_SQLite_database_to_ovipositor_database.py``.
        
        .. code:: bash
        
            convert_YOURLS_SQLite_database_to_ovipositor_database.py --help
        
            convert_YOURLS_SQLite_database_to_ovipositor_database.py \
                --databaseyourls=linkdb.db                           \
                --databaseovipositor=ovipositor.db
        
        The YOURLS database contains three tables, "yourls\_url",
        "sqlite\_sequence" and "yourls\_options". The tables have the following
        fields:
        
        -  yourls\_url
        
           -  clicks
           -  ip
           -  keyword
           -  timestamp
           -  title
           -  url
        
        -  sqlite\_sequence
        
           -  name
           -  seq
        
        -  yourls\_options
        
           -  option\_id
           -  option\_name
           -  option\_value
        
        In changing from YOURLS to ovipositor, the following database table and
        field conversions are made:
        
        +-------------------------------------+-------------------------------------+
        | **yourls\_url**                     | **ovipositor**                      |
        +=====================================+=====================================+
        | yourls\_url                         | shortlinks                          |
        +-------------------------------------+-------------------------------------+
        | clicks                              | count                               |
        +-------------------------------------+-------------------------------------+
        | ip                                  | IP                                  |
        +-------------------------------------+-------------------------------------+
        | keyword                             | shortlink                           |
        +-------------------------------------+-------------------------------------+
        | url                                 | URL                                 |
        +-------------------------------------+-------------------------------------+
        | timestamp (``datetime.datetime``)   | timestamp (``datetime.datetime``)   |
        +-------------------------------------+-------------------------------------+
        | title                               | comment                             |
        +-------------------------------------+-------------------------------------+
        
Platform: UNKNOWN
