Skip to content

itvends/vlege

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vlege

Table of Contents

  1. About
  2. Usage
  3. Copyright
  4. Changelog
  5. Authors
  6. License

About

Vlege is a Very Low-Effort Gallery Engine, powering HTML image galleries based upon a native filesystem structure. Complicated server-side scripting languages and databases are eschewed in favor of basic HTML and JavaScript generated using a simple Python script and some helpful libraries.

Usage

First make sure you have Python3 and the necessary libraries installed, using your system's package system or via pip. You will need Jinja2 and Pillow(with JPEG support). Install Vlege by downloading the script and placing it in your $PATH somewhere.

$ mkdir ~/bin
$ PATH=$PATH:~/bin
$ git clone https://madeitwor.se/vlege.git
$ ln -s vlege/vlege/vlege.py ~/bin/vlege
$

Now run Vlege by pointing it at your album.

$ vlege /path/to/your/album/
$

If everything went well, you should get a pile of -thumb images, and an index.html listing. If everything didn't go well, you'll get an error message and possibly a stacktrace.

Copyright

Vlege is Copyright© 2014-2015 by Vlege Authors, enumerated in the Authors section of this README document. Detailed authorship can be found by examining the source code repository via the git blame command.

The Vlege name is Copright© 2014-2015 Eugene E. Kashpureff Jr, and is pending trademark registration in the United States of America. Usage of the name is permitted when referring to the Vlege software or its usage. See the License section of this document for the grants associated with this mark.

Any included libraries are copyright by their respective authors, as noted in their source files.

Changelog

Changelog for this release(v0.2):

  • First recommended release
  • Index files are generated
  • Uses square thumbnails
  • Learned --dryrun
  • Internal refactoring

See the CHANGELOG for historical entries, or the git source repository for per-commit change information.

Authors

Primary Author & Maintainer:

License

Vlege is offered as free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. If you wish to obtain Vlege under another license(including a proprietary commercial license) for inclusion into other software or use in a situation where the GNU GPL is not acceptable, you may contact the Maintainer for further information.

When obtained under the GNU General Public License, Vlege is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Vlege. If not, you may obtain it from the GNU Project.

Usage of the Vlege mark is restricted to the primary Vlege software distributed by Eugene E. Kashpureff Jr, and references to and usage of the same. Further permission is given to use this mark in a manner consistent with the purpose and image of the brand, eg, "Powered by Vlege".

Any public distribution, fork, or usage of Vlege which differs substantially from the original must be rebranded to prevent confusion with the canonical distribution. Reference to Vlege is permitted(eg, "Based upon Vlege"), within the same reasonable conditions associated with the mark. Operation of a mirrored software repository, containing only a faithful redistribution of the original, is permitted, with the provision that it is to be marked as such.

Software or services which include Vlege code must maintain the Authors listing and License information contained in this document within their source code and any further redistributions. You may change the License to any license which is forward-compatible with the License under which you obtained Vlege, including any versions of the GNU General Public License higher than 3, or the GNU Affero General Public License version 3 or higher.

Software or services which utilize Vlege in an unchanged or minimally altered format(eg, dynamic or static linking of the code) may do so without further attribution, but any such attribution is appreciated by the authors, if present. The suggested format is: "Powered by Vlege", with the 'Vlege' mark being a hyperlink to the named website, if the medium supports it.

The full source code for Vlege is available on Github.

About

Very Low Effort Gallery Engine

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages