-
-
Notifications
You must be signed in to change notification settings - Fork 13
Docker Template for the Project #267
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
Open
Tatianah3
wants to merge
15
commits into
main
Choose a base branch
from
feature/docker-template
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
6824faa
Add devcontainer Dockerfile and .dockerignore, update pyproject.toml
github-actions[bot] dc4ae70
Merge branch 'main' into feature/docker-template
smorin 7d52049
Merge branch 'main' into feature/docker-template
smorin 16e02fa
Merge branch 'main' into feature/docker-template
Tatianah3 236ee27
Merge branch 'main' into feature/docker-template
smorin 417fe95
Merge branch 'main' into feature/docker-template
Tatianah3 812bbc4
Devcontainer improvements
github-actions[bot] f357c99
Devcontainer improvements
github-actions[bot] 2cbbd3a
update the current docker file with new config
husnain067 17f0889
Merge branch 'main' into feature/docker-template
husnain067 03ab3d2
update the docker script file and just commands
husnain067 dbd3576
revert pyproject.toml changes
husnain067 6247b5a
update the docker.md doc file
husnain067 732547d
update the docker.md doc
husnain067 be5bb38
add a docker section in the readme file
husnain067 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
FROM python:3.11-slim | ||
|
||
# Install system dependencies, docker CLI, git, 'just', and 'uv' | ||
RUN apt-get update && apt-get install -y --no-install-recommends \ | ||
curl unzip ca-certificates gnupg docker.io git \ | ||
&& curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to /usr/local/bin \ | ||
&& curl -LsSf https://astral.sh/uv/install.sh | sh \ | ||
&& mv /root/.local/bin/uv /usr/local/bin/ \ | ||
&& mv /root/.local/bin/uvx /usr/local/bin/ \ | ||
&& apt-get clean && rm -rf /var/lib/apt/lists/* | ||
|
||
WORKDIR /app | ||
|
||
# Copy project files | ||
COPY pyproject.toml ./ | ||
COPY README.md ./ | ||
COPY py_launch_blueprint/ ./py_launch_blueprint/ | ||
COPY .git/ ./.git/ | ||
COPY tests/ ./tests/ | ||
COPY Justfile ./ | ||
|
||
# Install build dependencies | ||
RUN pip install --no-cache-dir --upgrade pip hatchling hatch-vcs | ||
|
||
# Install the package using uv | ||
RUN uv pip install --system --no-cache . | ||
|
||
# Use correct entrypoint (CLI command name, not package name) | ||
ENTRYPOINT ["py-launch"] |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
__pycache__/ | ||
.devcontainer/ | ||
.vscode/ | ||
*.pyc | ||
*.pyo | ||
*.pyd | ||
*.pytest_cache/ |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
# Using Docker with `py-launch-blueprint` | ||
|
||
This project includes Docker support for running and testing the CLI tool in a consistent, isolated environment. The containerized version includes all necessary dependencies and tools — including the CLI, `just`, `uv`, Docker CLI, and development tools. | ||
|
||
## Purpose and Problem Solved | ||
Docker support automates the setup of a consistent development and runtime environment for the py-launch CLI tool. It eliminates "works on my machine" issues and provides a reproducible environment with all dependencies pre-installed, helping maintain development consistency and simplifying deployment. | ||
|
||
## Key Benefits and Value Proposition | ||
- **Consistent environment** across all development machines and CI/CD | ||
- **Pre-installed dependencies** including Python 3.11, uv, just, and Docker CLI | ||
- **Isolated execution** preventing conflicts with local Python installations | ||
- **Fast setup** with single command container builds | ||
- **CI/CD ready** for automated testing and deployment | ||
|
||
--- | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
- [Docker](https://www.docker.com/) installed and running | ||
|
||
### Basic Setup Steps | ||
1. Ensure Docker is installed and running on your system | ||
2. Build the container using the provided justfile commands | ||
3. The container includes all necessary tools and your CLI application pre-installed | ||
|
||
### Quick Example | ||
```bash | ||
# Build the Docker container | ||
just container-setup | ||
|
||
# Test the CLI tool | ||
just container-test | ||
``` | ||
|
||
--- | ||
|
||
## Usage | ||
|
||
### Common Use Cases | ||
- **Development**: Test CLI changes in isolated environment | ||
- **CI/CD**: Run automated tests and builds | ||
- **Distribution**: Package and deploy the CLI tool | ||
- **Troubleshooting**: Debug issues in clean environment | ||
|
||
--- | ||
|
||
## Configuration | ||
|
||
### Key Configuration Options | ||
- **Base Image**: `python:3.11-slim` (lightweight and secure) | ||
- **Working Directory**: `/app` | ||
- **Build Backend**: Hatchling with hatch-vcs for version management | ||
- **Package Manager**: uv for fast dependency installation | ||
|
||
--- | ||
|
||
## Testing | ||
|
||
### Standalone Testing | ||
```bash | ||
# Build and test the container | ||
just container-setup | ||
just container-test | ||
``` | ||
|
||
--- | ||
|
||
## Troubleshooting | ||
|
||
### Common Issues | ||
1. **Build Failures**: Clean rebuild with `docker build --no-cache` | ||
2. **Permission Issues**: Run as current user with `--user $(id -u):$(id -g)` | ||
3. **Token Authentication**: Verify `PY_TOKEN` environment variable is set | ||
|
||
### Debug Commands | ||
```bash | ||
# Access container shell for debugging | ||
docker run --rm -it --entrypoint /bin/bash py-launch-dev:latest | ||
|
||
# Check build logs | ||
docker build --no-cache -t py-launch-dev:latest -f .devcontainer/Dockerfile . --progress=plain | ||
``` | ||
|
||
--- | ||
|
||
## References | ||
|
||
- [Docker Documentation](https://docs.docker.com/) | ||
- [Python 3.11 Docker Images](https://hub.docker.com/_/python) |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.