Metadata-Version: 2.1
Name: django-ytindex
Version: 0.1.66
Summary: Django app for managing a searchable index of Youtube videos
Home-page: https://www.example.com/
Author: ulfurk
Author-email: ulfurk@ulfurk.com
License: BSD License
Description: 
        # ytindex
        
        ytindex is a Django app for managing a searchable index of Youtube videos and
        their captions. The app relies on Elasticsearch for the indexing and searching.
        The app has no admin, no models and only provides one restful endpoint for
        making queries.
        
        To use
        -----------
        
          Install Elasticsearch and then install
        
          ```
          pip install django-ytindex django
          ```
        
        1. Add "ytindex" to your INSTALLED_APPS
        
            ```
            INSTALLED_APPS = [
                ...
                'ytindex',
            ]
            ```
        
        2. Include the ytindex URLconf in your project urls.py
        
            ```
            path('yti/', include('ytindex.urls')),
            ```
        
        3. Define the channel id of the Youtube channel you want to index and the
           Elasticsearch config you want to use
           ```
             YTCI_SETTINGS = {
                 'api_key':'AIzaSyCrGGcnVjY8AV7XWSHEIco3TDw4qobkh1w',
                 'jrei': {
                     'channel_id': 'UCzQUP1qoWDoEbmsQxvdjxgQ',
                     'line_size': 12,
                     'elastic': {
                         'index': 'jre-index',
                         'dtype': 'jrei-episode',
                         'es_host': 'localhost:9200'
                     }
                 }
             }
            ```
        
        4. Run
        
            ```
              ./manage index_latest [index name eg. jrei]
            ```
        
           to index the latest videos on the channel. (Put this in crontab)
        
        5. Run the dev server and visit http://127.0.0.1:8000/yti/jrei/elk to search the index.
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
