diff --git a/.buildkite/screenshot.png b/.buildkite/screenshot.png new file mode 100644 index 0000000..dc432b1 Binary files /dev/null and b/.buildkite/screenshot.png differ diff --git a/.buildkite/template.yml b/.buildkite/template.yml index 3c17442..a5cd76e 100644 --- a/.buildkite/template.yml +++ b/.buildkite/template.yml @@ -1,5 +1,10 @@ -# Used by the 'Add to Buildkite' button in the readme name: "Python Docker Example" +description: "An example pipeline that runs Python tests inside a Docker container using uv for dependency management." +emoji: ":python:" +color: "#EFF9FF" +languages: + - "Python" + - "Docker" steps: - label: ":pipeline:" command: "buildkite-agent pipeline upload" diff --git a/License.md b/LICENSE.md similarity index 96% rename from License.md rename to LICENSE.md index 42df5fa..66db09b 100644 --- a/License.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2017 Buildkite Pty Ltd +Copyright (c) 2025 Buildkite Pty Ltd Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md new file mode 100644 index 0000000..aaefb18 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Buildkite Python Docker Example (using uv) + +[![Build status](https://badge.buildkite.com/a947f64837044296a1ea4394819872e0544a4647a3400e6634.svg?branch=main)](https://buildkite.com/buildkite/python-docker-example/builds/latest?branch=main) +[![Add to Buildkite](https://img.shields.io/badge/Add%20to%20Buildkite-14CC80)](https://buildkite.com/new) + +This repository is an example [Buildkite](https://buildkite.com/) pipeline that tests a [Python](https://python.org) project using [Docker](https://www.docker.com/) and [uv](https://docs.astral.sh/uv/), a fast Python package manager. + +👉 **See this example in action:** [buildkite/python-docker-example](https://buildkite.com/buildkite/python-docker-example/builds/latest?branch=main) + +See the full [Getting Started Guide](https://buildkite.com/docs/guides/getting-started) for step-by-step instructions on how to get this running, or try it yourself: + +[![Add to Buildkite](https://buildkite.com/button.svg)](https://buildkite.com/new) + + + Screenshot of Buildkite Python Docker example pipeline + + + + +## How it works + +This example: +- Uses a [`Dockerfile`](Dockerfile) to set up Python and install dependencies using `uv` +- Defines an `app` service in [`docker-compose.yml`](docker-compose.yml) +- Runs the build using Docker Compose via a standard Buildkite pipeline step + + + +## License + +See [LICENSE.md](LICENSE.md) (MIT) diff --git a/Readme.md b/Readme.md deleted file mode 100644 index 8485596..0000000 --- a/Readme.md +++ /dev/null @@ -1,15 +0,0 @@ -# Buildkite Python Docker Example (using uv) - -[![Add to Buildkite](https://buildkite.com/button.svg)](https://buildkite.com/new) - -This repository is an example on how to test a [Python](https://python.org) project using [Buildkite](https://buildkite.com/), [Docker](https://www.docker.com/) and [uv](https://docs.astral.sh/uv/). - -## How does it work? - -* The [Dockerfile](Dockerfile) sets up the uv environment, and installs the dependencies -* The [docker-compose.yml](docker-compose.yml) defines the 'app' Docker service and how it should be built -* The [pipeline.yml](.buildkite/pipeline.yml) runs the command using Docker Compose - -## License - -See [Licence.md](Licence.md) (MIT)