search

loris-imageserver / loris

Loris IIIF Image Server
Other
209 stars 87 forks source link

Setup changes #449

Closed bcail closed 5 years ago

bcail commented 5 years ago

Remove initialization code from setup.py - setup.py just installs the python package. Add a user_commands.py module for users to run setup/init commands after install, if desired.

minusdavid commented 5 years ago

Does the change work when installing with pip?

From a packager perspective, this isn't quite good enough. Could you add a BASE_DIR or PREFIX for each of the files created by the "create_default_files_and_directories" function? That way, a packager could specify a package-specific buildroot and then move the files to the vendor specific place they need to go.

minusdavid commented 5 years ago

It feels like my suggestion is re-inventing the wheel... so surely there must be other Python web apps that get packaged which have solved this one.

That said, it looks like other people have grappled with this question: https://wiki.debian.org/DjangoPackagingDraft

This one is very old but I think was the basis of the Koha Debian package: https://people.debian.org/~neilm/webapps-policy/

minusdavid commented 5 years ago

Seems like Python admits that it's a difficult problem as well: https://packaging.python.org/overview/

Looking at https://packages.debian.org/stretch/fail2ban, it looks like it uses data_files for /etc and /var files.

At https://github.com/fail2ban/fail2ban/issues/1536, they also refer to using --root for deployments.

According to some comments at https://ubuntuforums.org/showthread.php?t=1713458, Debian package scripts call the following under the hood:

python setup.py build python setup.py install --root=debian/package-name/usr --install-layout=deb

The following links speak to that more: https://www.debian.org/doc/packaging-manuals/python-policy/packaging_tools.html#dh-python https://manpages.debian.org/testing/python/dh_python2.1.en.html

minusdavid commented 5 years ago

The more I look at this... the more I'd have to sit down and spend some time trying out package builds again. Rather than just Googling on a Saturday night... heh.

bcail commented 5 years ago

@minusdavid thanks for looking at this. If you want to customize where files are installed, one way to do that with this PR is to customize and pass a python config object into the user_commands.create_default_files_and_directories function. Take a look at the tests/user_commands_t.py module, where I set the function to install the files into a temp directory.

Does that help with creating a package at all? If not, could this PR be a first step, and then we add another option if needed?

minusdavid commented 5 years ago

@bcail Thanks for doing the work!

But no I don't think that would help with creating a package.

But yeah I think this PR would be a first step and then something else could be done to aid with packaging. I don't have the time to invest in this anymore, so I don't want to hold anyone up either.

bcail commented 5 years ago

ok, thanks @minusdavid. @alexwlchan any thoughts on this?