Skip to content

Commit 0594c13

Browse files
committed
README updates to explain project goals
1 parent 3a1b795 commit 0594c13

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# Python Container Builder
2+
[![Build & Deploy Nightly](https://github.com/jski/python-container-builder/actions/workflows/build-and-push.yml/badge.svg?branch=main)](https://github.com/jski/python-container-builder/actions/workflows/build-and-push.yml)
3+
24
A shortcut to packaging your Python code with requirement dependencies into a Distroless image.
35

4-
## Getting Started
5-
### Prerequisites
6-
- Have Python code you wish to package in a distroless container image.
7-
- Have a method of building containers, either locally or in Github Actions (or similar CI orchestrator).
6+
## Goals
7+
This project seeks to:
8+
- Simplify the build/packaging process for simple Python projects.
9+
- Reduce usage of Github Actions free tier minutes for said projects by doing the most time-intensive part up front here instead.
10+
- Offer an base image that supports packaging into a final distroless runtime.
11+
- Keep up to date with package updates to the Debian-based build image without having to think about it.
12+
- Support both `linux/arm64` and `linux/amd64` build options.
13+
- Be publicly available for use without needing to login to a registry.
814

15+
## Getting Started
916
### Quickstart Example
1017
> I have a standalone Python file, `main.py`, in the root folder of my repo requiring dependencies that are declared in `requirements.txt`.
1118
```

0 commit comments

Comments
 (0)