etiquette/README.md

Etiquette
=========

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_flask_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`.

### Project stability

You may notice that Etiquette doesn't have a version number anywhere. That's because I don't think it's ready for one. I am using this project to learn and practice, and breaking changes are very common.

### Contributing

If you are interested in helping, please raise an issue before making any pull requests!


### To do list
- Make the wording between "new", "create", "add"; and "remove", "delete" more consistent.
- 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.
- Ability to access user photos by user's ID, not just username.
- Should album size be cached on disk?
- Replace columns like area, ratio, bitrate by using expression indices or views (`width * height` etc).
- Add some way to support large image albums without flooding the search results. Considering a "hidden" property so that a handful of representative images can appear in the search results, and the rest can be found on the actual Album page.
- Add a `Photo.merge` to combine duplicate entries.
- Generate thumbnails for vector files.
- Allow photos to have nonstandard, orderby-able properties like "release year". How?
- Make the FFmpeg path configurable. Some kind of global config? Or part of the database config file? It's not like every photodb needs a separate one.
- Improve the appearance of album page. Too many section headers and the "Create album" interface should allow giving a title immediately.
- When users have '%' or '#', etc. in their username, it is difficult to access their /user/ URL. I would prefer to fix it without simply blacklisting those characters.

### 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.

&nbsp;
create exceptions.py and move more constants 2016-12-13 03:49:36 +00:00			`Etiquette`
			`=========`

Add demo link to readme 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.`
create exceptions.py and move more constants 2016-12-13 03:49:36 +00:00
Add basic project description to readme 2017-03-17 22:24:59 +00:00			`### 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:`

Minor cosmetics 2017-05-07 00:04:42 +00:00			- `python etiquette_flask_launch.py [port]` to launch the flask server. Port defaults to 5000 if not provided.
Add basic project description to readme 2017-03-17 22:24:59 +00:00			- `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`.

Update Readme: Stability and Contributing and to-do. 2017-07-14 06:53:42 +00:00			`### Project stability`

			`You may notice that Etiquette doesn't have a version number anywhere. That's because I don't think it's ready for one. I am using this project to learn and practice, and breaking changes are very common.`

			`### Contributing`

			`If you are interested in helping, please raise an issue before making any pull requests!`


Add early support for user accounts 2016-12-16 23:45:46 +00:00			`### To do list`
Update to-do list on readme 2017-03-17 07:26:55 +00:00			`- Make the wording between "new", "create", "add"; and "remove", "delete" more consistent.`
Add early support for user accounts 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.
Add /userid/id redirect to /user/name 2017-06-20 00:03:07 +00:00			`- Ability to access user photos by user's ID, not just username.`
Minor commentary and cleanup 2017-05-13 22:27:08 +00:00			`- Should album size be cached on disk?`
			- Replace columns like area, ratio, bitrate by using expression indices or views (`width * height` etc).
Minor improvements, update to-do list. 2017-04-21 01:31:48 +00:00			`- Add some way to support large image albums without flooding the search results. Considering a "hidden" property so that a handful of representative images can appear in the search results, and the rest can be found on the actual Album page.`
Floating point h:m:s, and update to-do. 2017-06-12 04:09:17 +00:00			- Add a `Photo.merge` to combine duplicate entries.
Add more stuff to the to-do list. 2017-07-09 22:48:47 +00:00			`- Generate thumbnails for vector files.`
Update Readme: Stability and Contributing and to-do. 2017-07-14 06:53:42 +00:00			`- Allow photos to have nonstandard, orderby-able properties like "release year". How?`
Update the to do list. 2017-07-29 23:23:24 +00:00			`- Make the FFmpeg path configurable. Some kind of global config? Or part of the database config file? It's not like every photodb needs a separate one.`
Update Readme: Stability and Contributing and to-do. 2017-07-14 06:53:42 +00:00			`- Improve the appearance of album page. Too many section headers and the "Create album" interface should allow giving a title immediately.`
Update the to do list. 2017-07-29 23:23:24 +00:00			`- When users have '%' or '#', etc. in their username, it is difficult to access their /user/ URL. I would prefer to fix it without simply blacklisting those characters.`
Add early support for user accounts 2016-12-16 23:45:46 +00:00
create exceptions.py and move more constants 2016-12-13 03:49:36 +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.`

			` `