Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.42 KB

README.md

File metadata and controls

65 lines (48 loc) · 2.42 KB
Raw

docker-python-dojo

A Dojo docker image with Python. Based on official Python image.

Specification

This image has installed:

  • python 3
  • virtualenv, tox, devpi-client

If you want to use a devpi server, set environment variables:

  • KUDU_DEVPI_INDEX - if it is set, then devpi use --set-cfg --pip-set-trusted=yes "${KUDU_DEVPI_INDEX}" will be run
  • KUDU_DEVPI_LOGIN - if it is set, then devpi login --password "${KUDU_DEVPI_PASSWORD}" "${KUDU_DEVPI_LOGIN}" will be run
  • KUDU_DEVPI_PASSWORD - may be empty

Usage

  1. Setup docker.
  2. Install Dojo binary.
  3. Provide a Dojofile:
DOJO_DOCKER_IMAGE="kudulab/python-dojo:2.0.1"
# or:
# DOJO_DOCKER_IMAGE="kudulab/python-dojo:latest"
  1. Create and enter the container by running dojo at the root of project.
dojo "python --help"

By default, current directory in docker container is /dojo/work.

Development

Dependencies

  • Bash
  • Docker daemon
  • Bats
  • Dojo

Contributing

Instructions how to update this project.

  1. Create a new feature branch from the main branch
  2. Work on your changes in that feature branch. If you want, describe you changes in CHANGELOG.md
  3. Build your image locally to check that it succeeds: ./tasks build
  4. Test your image locally: ./tasks itest. You may need to install the test framework - you can do it following these instructions
  5. If you are happy with the results, create a PR from your feature branch to master branch

After this, someone will read your PR, merge it and ensure version bump (using ./tasks set_version). CI pipeline will run to automatically build and test docker image, release the project and publish the docker image.

License

Copyright 2019-2024 Ava Czechowska, Tom Sętkowski

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and