DOCLIB

A document library that integrates with multiple data sources (like digiLocker, Google Drive, local storage etc.) and storage services (like S3 and Google Cloud Storage) and uploads data from these data sources to the chosen storage service. It can be integrated with any Django Project.

With multiple different software and accounts being used to store our documents and images, the files that are important to us are spread out across these. This creates a need to bring all these files into a storage service, making it easier to store, search and keep track of files in one place.

• Demo Video

TECHNOLOGIES

• Python
• Django: Django builds better web apps with less code
• DRF: A powerful and flexible toolkit for building Rest APIs with Django
• Frontend: HTML5, Bootstrap, JS
• Architecture of the Library

CURRENT SUPPORTED SERVICES

DATA SOURCES

• Google Drive

• Local Storage

• Digimocker (mock of Digilocker)

STORAGE SERVICES

• Amazon S3

• Google Cloud Storage

QUICKSTART

Install the package

pip3 install django-doclib

Before running the server, make sure Directory looks like

demo_proj
├── credentials_dir
|      └── credentials_gcs.json
├── media
└── django_project_folder
    ├── settings.py
    ├── asgi.py
    ├── .env
    ├── wsgi.py
    └── urls.py

Follow the steps

1. Add doclib and rest_framework to your INSTALLED_APPS of settings.py like this

   INSTALLED_APPS = [
   ...
   'doclib',
   'rest_framework',
   ]

2. Include the doclib URLconf in your project urls.py like this

   from django.conf.urls import include

   path('doclib/', include('doclib.urls'))

3. Provide MEDIA_ROOT in your project settings.py, something like this

   import os

   MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

4. For integrating with Google Drive

   • Make a directory with name credentials_dir at the project root level

   • Put the google api client secret json file with name as credentials_gcs.json in credentials_dir directory For getting the API and Developer keys, visit here.

   • Make a .env file in the project folder directory (at the project settings.py level) and put the Browser API keys obtained from the Google API Console like this (don’t use quotations around strings)

     DEVELOPER_KEY=##################
     CLIENT_ID=##################
     APP_ID=##################

5. For setting the environment variables, follow this

   • Add these below lines in the project settings.py

     import environ
     env = environ.Env()
     environ.Env.read_env()

   • For setting the above API Keys put these below lines in the settings.py

     DEVELOPER_KEY = env("DEVELOPER_KEY")
     CLIENT_ID     = env("CLIENT_ID")
     APP_ID        = env("APP_ID")

6. Run python3 manage.py migrate to create the doclib models.

7. Start the development server by running python3 manage.py runserver localhost:8000

8. Visit http://localhost:8000/doclib/ to access the doclib.

REPOSITORY WALKTHROUGH

doclib

Contains the source code of the library

slicedoc

A demo django project using doclib library

For using this django project

1. install the library package

2. Clone the repo

3. Change working directory to repo_folder

   cd path/to/repo_folder

4. Go to slicedoc folder

   cd slicedoc

5. Put the google api client secret json file with name as credentials_gcs.json in credentials_dir directory

6. Set the Django Secret Key and Browser API keys obtained from the Google API Console in the .env file in project directory

7. Run python manage.py migrate to create the doclib models.

8. Start the development server by running python manage.py runserver localhost:8000

9. Visit http://localhost:8000/doclib/ to access the doclib.