Skip to content

Commit

Permalink
docs: simplify
Browse files Browse the repository at this point in the history
  • Loading branch information
MultifokalHirn committed Nov 13, 2023
1 parent a03bb33 commit d33d04a
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/python-checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
max-parallel: 2
# fail-fast: true
matrix:
python-version: [3.8, 3.11]
python-version: [3.11]

steps:
- uses: actions/checkout@v3
Expand Down
91 changes: 53 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,99 @@
<div align="center">
![GitHub last commit](https://img.shields.io/github/last-commit/MultifokalHirn/python_template_repo)
![GitHub issues](https://img.shields.io/github/issues/MultifokalHirn/python_template_repo)
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/MultifokalHirn/python_template_repo)

<div align="center">
<p style="font-size:22px"> 🏗️ This project is currently under construction 🏗️ </p>
<br>
</div>

<!-- omit in toc -->
# Python Project Template

![GitHub last commit](https://img.shields.io/github/last-commit/MultifokalHirn/python_template_repo)
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/MultifokalHirn/python_template_repo)
![GitHub issues](https://img.shields.io/github/issues/MultifokalHirn/python_template_repo)

![py3](https://img.shields.io/badge/python->=3.8-306998)
# Python Project Template
> Check out the [Roadmap](#roadmap) for planned features
This is my personal template for a python project containing everything needed to start developing.

<!-- omit in toc -->
## Features

![constr](https://img.shields.io/badge/🏗️-under%20construction-FFD43B)
## Features

> Check out the [roadmap](#roadmap) for planned features
<!-- ![constr](https://img.shields.io/badge/🏗️-under%20construction-FFD43B) -->


### Python Development
<!--
[![Python Version](https://img.shields.io/pypi/pyversions/Django?branch=master&label=Python&logo=Python&logoColor=ffffff&labelColor=306998&color=FFD43B&style=flat)](https://pypi.org/project/amazoncaptcha/) -->

![pdm](https://img.shields.io/badge/pdm-managed-blueviolet)
[![mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
![py3](https://img.shields.io/badge/-python>=3.8-3776AB?logo=python&logoColor=FFFFFF&style=flat-square)
![pdm](https://img.shields.io/badge/depedency_manager-pdm-blueviolet?logoColor=FFFFFF&style=flat-square)
![pytest](https://img.shields.io/badge/testing-pytest-0A9EDC?logo=pytest&logoColor=FFFFFF&style=flat-square)
![mypy](https://img.shields.io/badge/typechecker-mypy-blue?&style=flat-square)
![flake8](https://img.shields.io/badge/linter-flake8-006400?&style=flat-square)
![isort](https://img.shields.io/badge/autofix-isort-yellow?&style=flat-square)
<!-- ![isort](https://img.shields.io/badge/isort-blue?&style=flat-square) -->

<!-- ![mypy](https://img.shields.io/badge/mypy-checked-blue?&style=flat-square)
[![mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/) -->

- `pdm` for dependency management
<!-- - `pdm` for dependency management
- packages for:
- linting and static analysis with `flake8` and `mypy`
- auto-fixing with `autopep8` and `isort`
- `pytest` for testing
- `pytest` for testing -->
- Code base skeleton with [`src/`](./src/) and [`tests/`](./tests/) folders

### Developer Tooling
### CI, CD, and Dev Tooling

![make](https://img.shields.io/badge/Makefile-FFFFFF?logo=gnu&logoColor=A42E2B&style=flat-square)
![docker](https://img.shields.io/badge/-Docker-FFFFFF?logo=docker&style=flat-square)
![ghactions](https://img.shields.io/badge/Github_Actions-FFFFFF?logo=githubactions&style=flat-square)
![conventionalcommits](https://img.shields.io/badge/Conventional%20Commits-FFFFFF?logo=conventionalcommits&style=flat-square)
<!-- [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square)](https://github.com/pre-commit/pre-commit&style=flat-square) -->
<!-- [![conventional-commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg&style=flat-square)](https://conventionalcommits.org&style=flat-square) -->

### Sensible Configuration

- [`Makefile`](./Makefile) for easy setup, testing, linting, etc.
![pyproject](https://img.shields.io/badge/pyproject.toml-000000?logo=python&style=flat-square)
![precommit](https://img.shields.io/badge/.pre--commit--config.yaml-000000?logo=precommit&style=flat-square)
![editorconfig](https://img.shields.io/badge/-.editorconfig-000000?logo=editorconfig&style=flat-square)
![visualstudiocode](https://img.shields.io/badge/-.vscode/-000000?logo=visualstudiocode&logoColor=007ACC&style=flat-square)
![templates](https://img.shields.io/badge/Templates-000000?logo=github&logoColor=FFFFFF&style=flat-square)


<!-- - [`Makefile`](./Makefile) for easy setup, testing, linting, etc.
- docker-compose for easy setup of dev environment
- Configuration for
- python packages in [`pyproject.toml`](./pyproject.toml) and [`setup.cfg`](./setup.cfg)
- VSCode in [`.vscode/`](./.vscode)
- `pre-commit` hooks in [`.pre-commit-config.yaml`](./.pre-commit-config.yaml)
- [`pyenv`](./.python-version)
- Templates for [Issues](./.github/ISSUE_TEMPLATE.md) and [PRs](./.github/PULL_REQUEST_TEMPLATE.md) on GitHub
- and more...
- and more... -->



### CI & CD

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![conventional-commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
- GitHub Actions for
- linting & testing
- `semantic-release` for automated versioning and changelog generation
- `commitizen` for version control and changelog generation
<!-- [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) -->

<!-- - GitHub Actions for
- linting & testing -->
<!-- - `semantic-release` for automated versioning and changelog generation -->
<!-- - `commitizen` for version control and changelog generation -->

<!-- omit in toc
## Table of Contents
-->


## Roadmap

### v1 Release

- [ ] set up github actions for CI
- [ ] set up devcontainer
- [x] set up github actions for testing and linting
- [ ] set up github actions for semantic versioning
- [ ] set up dependabot
- [ ] set up coverage reporting
- [ ] set up semantic-release
- [ ] set up commitizen
- [ ] set up Dockerfile and docker-compose
- [ ] set up devcontainer
- [ ] set up coverage reporting
- [ ] set up semantic-release

### Demo Project

Expand All @@ -86,14 +105,12 @@ This is my personal template for a python project containing everything needed t
- [ ] document pyenv
- [ ] expand list of tools I have tried and decided against


### Ideas for the Future

- [ ] find out how to sync templates with projects that use them?
- [ ] check out tools like tox & nox
- [ ] check out pylint


## Getting Started

See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for information on how to setup and contribute to this project.
Expand All @@ -109,12 +126,10 @@ make ci # runs auto-fixes, linters and tests
make run # starts the application
```


## "Why don't you use X?"

> This template is meant to be a starting point for my own projects and may not follow other people's preferred setups.

Depending on the tool of configuration detail, I either actively decided against something or I have not yet tried them.

If you have any suggestions for improvements, or tools to check out, please [file an issue](https://github.com/MultifokalHirn/python_template_repo/issues).
Expand All @@ -136,7 +151,7 @@ If you have any suggestions for improvements, or tools to check out, please [fil

In this section, you will find some common issues you might encounter and how to resolve them. If you are experiencing any issues that are not covered here, please [file an issue](https://github.com/MultifokalHirn/python_template_repo/issues).

### I does not work! I tried everything!
### I does not work! I tried everything

Well, have you tried turning it off and on again?

Expand Down
4 changes: 4 additions & 0 deletions tests/unit/app/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@


def test_app():
assert True

0 comments on commit d33d04a

Please sign in to comment.