Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Package Configuration #4

Merged
merged 11 commits into from
May 14, 2020
Merged

Add Package Configuration #4

merged 11 commits into from
May 14, 2020

Conversation

jarojasm95
Copy link
Member

This PR adds package configuration so that the aladdin_command executable can be installed using pip and poetry.

Should be as easy as:
poetry add git+https://github.com/fivestars-os/[email protected]

@jcwilson
Copy link
Contributor

Can you add docs to the README to explain how one might use this when constructing their commands image?

setup.py Outdated Show resolved Hide resolved
examples/poetry_example/Dockerfile Outdated Show resolved Hide resolved
WORKDIR /the/workdir/path
ENV ALADDIN_COMMANDS_PATH='/the/workdir/path/commands_base_example'

COPY pyproject.toml ./
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also demonstrate copying the poetry.lock file over, too

Copy link
Member Author

@jarojasm95 jarojasm95 May 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added it as a comment, I did not want to commit that file here because it's basically a duplicate of the lock file in the repo root, which also makes this example harder to maintain when dependencies change

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we commit a dummy file here with a comment in it saying that it's a placeholder?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm so I don't see how a dummy file is an improvement over the comment in the line below, if using a blank dummy file with just a comment in it then the example is broken because poetry will complain about the lock file being out of sync with .toml, this way at least the example is pretty much ready to go, in any case I don't think we're aiming for this to be a poetry how-to

examples/base_docker_image/Dockerfile Outdated Show resolved Hide resolved
commands_base/__main__.py Outdated Show resolved Hide resolved
commands_base/__init__.py Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
commands_base/__init__.py Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
commands_base/__init__.py Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
commands_base/__init__.py Outdated Show resolved Hide resolved
examples/custom_docker_image/Dockerfile Outdated Show resolved Hide resolved
examples/poetry_example/Dockerfile Outdated Show resolved Hide resolved
Copy link

@ptramsey ptramsey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise lgtm!

Copy link

@ptramsey ptramsey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for amking all these changes!

@jarojasm95 jarojasm95 merged commit 096bd65 into master May 14, 2020
@jarojasm95 jarojasm95 deleted the setup.py branch May 14, 2020 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants