Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
draincoder committed Apr 1, 2024
1 parent 98e51c8 commit 2202c36
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
# pyproject
<div align="center">

# PyProject

[![python](https://img.shields.io/badge/python-3.12-blue)](https://www.python.org/)
[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Test](https://github.com/draincoder/pyproject/actions/workflows/ci.yaml/badge.svg)](https://github.com/draincoder/pyproject/actions/workflows/ci.yaml)

</div>

## Minimal infrastructure settings for a quick start of a Python project.

### Features:
1. [PDM](https://pdm-project.org/en/latest/) `package` manager
2. Configured `CI` with `tests` and `lints`
3. [Just](https://github.com/casey/just) for project `commands`
4. Configured `pre-commit`
## Highlights of features

- [PDM](https://pdm-project.org/en/latest/) `package` manager
- Configured `CI` with `tests` and `lints`
- [Just](https://github.com/casey/just) for project `commands`
- Configured `pre-commit`

2 comments on commit 2202c36

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report •
FileStmtsMissCoverMissing
TOTAL10100% 
report-only-changed-files is enabled. No files were changed during this commit :)

Tests Skipped Failures Errors Time
1 0 💤 0 ❌ 0 🔥 0.097s ⏱️

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report •
FileStmtsMissCoverMissing
TOTAL10100% 
report-only-changed-files is enabled. No files were changed during this commit :)

Tests Skipped Failures Errors Time
1 0 💤 0 ❌ 0 🔥 0.097s ⏱️

Please sign in to comment.