Skip to main content

Creates index.html for directory contents shared publicly on Dropbox. Easily share whole content of the directory without the need to send separate links for each file.

Project description

https://img.shields.io/pypi/v/dropbox-index.svg https://img.shields.io/pypi/pyversions/dropbox-index.svg tests Ruff Code style: Black https://img.shields.io/badge/skeleton-2023-informational

Introduction

dropbox-index creates index.html for directory contents shared publicly on Dropbox. Easily share whole content of the directory without the need to send separate links for all the shared files.

After installing, just run this Python script with directory as an argument (and add -R as an option if to include subdirectories):

Usage: dropbox-index [options] DIRECTORY

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -R, --recursive       Include subdirectories [default: False]
  -T TEMPLATE, --template=TEMPLATE
                        Use HTML file as template

ATTENTION: Script will overwrite any existing index.html file(s)!

Example: dropbox-index.py -R -T template.html ~/Dropbox/Public/show will generate index.html for directory (and subdirectories if run in recursive mode). Hidden files (filenames starting with ‘.’) are automatically omitted.

If a directory contains a file with dir-info in it’s name (dir-name, dir-name.txt, dir-name.html, - all these names are valid) the contents of the file will be used in the index.html as and additional information about directory content.

Click on the table’s headings to sort files by name, size, or date (in ascending and descending order).

Template

Templates can be used to generate custom index.html files. Selected template is used to generate all pages, including subdirectories if the script is run in recursive mode.

Templates are just regular HTML files. CSS styles and JavaScript code will be automatically injected. The table with the files list will be injected in place of %(FILES)s.

Use (names are case sensitive!):

  • %(FILES)s: must be included or the files list won’t be injected!

  • %(FAVICON)s: place it inside <head> if you want Dropbox-favicon to be used

  • %(ENCODING)s: system encoding identified by the script

  • %(PATH)s: name of the directory

  • %(DIR_INFO)s: place for additional directory information (from dir-info files Screenshot).

Icons

dropbox-index uses icons from famfamfam’s “Silk” icon set

Acknowledgements

Wojciech ‘KosciaK’ Pietrzok was the original author.

Tommy MacWilliam introduced the template system.

Jason R. Coombs ported the project to Python 3 and maintains it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dropbox-index-0.6.0.tar.gz (28.8 kB view hashes)

Uploaded Source

Built Distribution

dropbox_index-0.6.0-py3-none-any.whl (26.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page