Augment distribution #85
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add ruleset.conf.sample to the distribution and configure setuptools to install it together with the README, peekaboo.conf.sample and our systemd unit into an fhs-like documentation directory. Add a number of comments to setup.py so we remember why this seems to be the least disruptive way out of the limited options presented by the python/setuptools/distutils/pip mechanics of providing these files at a location visible to users and still somewhat manageable by alternative packagers (e.g. Linux distributions). In short again: - package_data would hide the files away below the site-packages directory making them invisible to the user and hard(er) to find programmatically - absolute paths really don't work well with data_files - relative paths work somewhat better but still not fully consistently between setup.py and pip - overriding the install command solves the installation but not the packaging problem
Add startup order relative to cuckoo-api to systemd unit. It's not a hard requirement (no Require=) but only ordering so that if a cuckoo-api service exists, we're started after it in case we're running in api mode and will actually try to talk to it.
Add mention to the documentation that peekaboo now installs sample peekaboo.conf and ruleset.conf files.
|
LGTM Find my comment here scVENUS/PeekabooAV-Installer#41 |
|
This should be approved, rather than closed, sorry |
Jack28
approved these changes
Jun 4, 2019
Document how we test PyPI interaction using devpi.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add additional files to the source distribution and install them into
<prefix>/share/doc/peekabooto give the user an actual chance to install and run us from only the PyPI distribution. This is also to be used by the installer so it does not rely on having the full source directory available and config file duplication is minimized.