Skip to content

Commit e7201c7

Browse files
authored
Dev/66 update poetry group dependencies (#67)
* Update readme * Update poetry's dependency groups
1 parent 47f93ae commit e7201c7

File tree

3 files changed

+461
-462
lines changed

3 files changed

+461
-462
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# python-template
22

3+
[![python](https://img.shields.io/badge/Python-3.10-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
[![build](https://github.com/piotr-rarus/python-template/actions/workflows/build.yml/badge.svg)](https://github.com/piotr-rarus/python-template/actions/workflows/build.yml)
6+
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
37
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
8+
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
49
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
5-
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
610

711
This is a template repository dedicated to ML projects in python. It provides some basic tools and configs necessary to kickstart the development.
812

@@ -14,7 +18,7 @@ This is a template repository dedicated to ML projects in python. It provides so
1418
- `src` - here goes your project's code
1519
- `src/cli` - project's entry points should be wrapped with CLI and exposed via Makefile, good idea to store them separately
1620
- `.codespell` - whitelist for project-related terms
17-
- `.coveragearc` - corage config config, usually you don't want to report coverage on CLI, tests and some expressions
21+
- `.coveragearc` - corage config, usually you don't want to report coverage on CLI, tests and some expressions
1822
- `.flake8` - `flake8` config
1923
- `isort.cfg` - `isort` config
2024
- `Makefile` - tasks definitions, much simpler to call `make` than writing whole commands in the terminal
@@ -78,4 +82,4 @@ This hook is here to prevent you from committing any nasty code to your reposito
7882

7983
## Closing remarks
8084

81-
Hopefully, this template helps you jump off your project. If any of these tools are unfamiliar to you, follow the links for more info on them. Feel free to customize it, this is a template after all. Personally, I often look up how my favourite libraries are developed and take what I like. If you feel you don't need any of it, good luck to you, and pray you won't meet me cleaning up your sloppy code.
85+
Hopefully, this template helps you jump off your project. If any of these tools are unfamiliar to you, follow the links for more info on them. Feel free to customize it, this is a template after all. Personally, I often look up how my favourite libraries are developed and take what I like.

0 commit comments

Comments
 (0)