etiquette/README.md

33 lines
1.6 KiB
Markdown
Raw Normal View History

Etiquette
=========
2017-03-17 21:03:15 +00:00
I am currently running a demonstration copy of Etiquette at http://etiquette.voussoir.net where you can browse around. This is not yet permanent.
### What am I looking at
Etiquette is a tag-based file organization system with a web front-end.
Documentation is still a work in progress. In general, I use:
- `python etiquette_site_launch.py [port]` to launch the flask server. Port defaults to 5000 if not provided.
- `python -i etiquette_repl.py` to launch the Python interpreter with the PhotoDB pre-loaded into a variable called `P`. Try things like `P.new_photo` or `P.digest_directory`.
2016-12-16 23:45:46 +00:00
### To do list
2017-03-17 07:26:55 +00:00
- Make the wording between "new", "create", "add"; and "remove", "delete" more consistent.
2016-12-16 23:45:46 +00:00
- User account system, permission levels, private pages.
- Improve the "tags on this page" list. Maybe add separate buttons for must/may/forbid on each.
- Some way for the database to re-identify a file that was moved / renamed (lost & found). Maybe file hash of the first few mb is good enough.
- Debate whether the `UserMixin.login` method should accept usernames or I should standardize the usage of IDs only internally.
2017-03-17 07:26:55 +00:00
- Album size is calculated every time you refresh the page. For large albums this is very slow. Consider caching? Or saving to db?
- Organize the tag exporter functions better.
2016-12-16 23:45:46 +00:00
### Changelog
- **[addition]** A new feature was added.
- **[bugfix]** Incorrect behavior was fixed.
- **[change]** An existing feature was slightly modified or parameters were renamed.
- **[cleanup]** Code was improved, comments were added, or other changes with minor impact on the interface.
- **[removal]** An old feature was removed.