https://github.com/ks6088ts/template-python

A GitHub template repository for Python
https://github.com/ks6088ts/template-python

black poetry pytest ruff trivy

Last synced: 28 days ago
JSON representation

A GitHub template repository for Python

• Host: GitHub
• URL: https://github.com/ks6088ts/template-python
• Owner: ks6088ts
• License: mit
• Created: 2024-03-14T00:55:59.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-08T01:10:18.000Z (2 months ago)
• Last Synced: 2024-09-08T06:50:36.009Z (2 months ago)
• Topics: black, poetry, pytest, ruff, trivy
• Language: Python
• Homepage: https://hub.docker.com/repository/docker/ks6088ts/template-python/general
• Size: 327 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
[![test](https://github.com/ks6088ts/template-python/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/ks6088ts/template-python/actions/workflows/test.yaml?query=branch%3Amain)

[![docker](https://github.com/ks6088ts/template-python/actions/workflows/docker.yaml/badge.svg?branch=main)](https://github.com/ks6088ts/template-python/actions/workflows/docker.yaml?query=branch%3Amain)

[![docker-release](https://github.com/ks6088ts/template-python/actions/workflows/docker-release.yaml/badge.svg)](https://github.com/ks6088ts/template-python/actions/workflows/docker-release.yaml)

[![ghcr-release](https://github.com/ks6088ts/template-python/actions/workflows/ghcr-release.yaml/badge.svg)](https://github.com/ks6088ts/template-python/actions/workflows/ghcr-release.yaml)

# template-python

This is a template repository for Python

## Prerequisites

- [Python 3.10+](https://www.python.org/downloads/)

- [Poetry](https://python-poetry.org/docs/#installation)

- [GNU Make](https://www.gnu.org/software/make/)

## Development instructions

### Local development

Use Makefile to run the project locally.

```shell

# help

make

# install dependencies for development

make install-deps-dev

# run tests

make test

# run CI tests

make ci-test

```

### Docker development

```shell

# build docker image

make docker-build

# run docker container

make docker-run

# run CI tests in docker container

make ci-test-docker

```

To publish the docker image to Docker Hub, you need to set the following secrets in the repository settings.

```shell

gh secret set DOCKERHUB_USERNAME --body $DOCKERHUB_USERNAME

gh secret set DOCKERHUB_TOKEN --body $DOCKERHUB_TOKEN

```