1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
.TH TASKPY 1 "July 2024" "Taskipy Manual"
.SH NAME
.B taskipy \- Taskipy automation tool for Python projects
.SH SYNOPSIS
.B task
[\-h] [\-\-help] [\-\-list] [name] [args]
.SH DESCRIPTION
.nf
.fam C
The Taskipy project is a utility for automating tasks in Python projects,
providing a simple way to define and execute various development tasks. It
allows tasks like style checking (lint) or other operations to be defined
and executed via a single configuration file.
.fam T
.fi
.SH USAGE
.nf
.fam C
To install Taskipy as a dev dependency, use Poetry:
.B
poetry add --dev taskipy
For Anaconda Python-based environments, Taskipy is also available via conda-forge:
.B
conda install -c conda-forge taskipy
.fam T
.fi
.SH OPTIONS
.B
\-h, \-\-help
Show help message and exit.
.B
\-l, \-\-list
Show a list of available tasks.
.SH EXAMPLES
To list available tasks:
.B
task \-l
To run a specific task:
.B
task test
Available tasks include:
.TP
.B test
Runs all tests.
.TP
.B post_test
Runs linting after tests: ./task lint.
.TP
.B test_windows
Command used by Windows CI on Github.
.TP
.B lint
Lints project using pylint for style and mypy for typings.
.TP
.B lint_pylint
Runs pylint tests for Taskipy.
.TP
.B lint_mypy
Runs mypy tests for Taskipy.
.TP
.B make_release_commit
Creates a tagged commit for the release. Do not use directly.
.TP
.B pre_publish_patch
Runs tests before publishing a patch version: ./task test.
.TP
.B publish_patch
Publishes a patch version that includes fixes but no new features (x.x.PATCH).
.TP
.B pre_publish_minor
Runs tests before publishing a minor version: ./task test.
.TP
.B publish_minor
Publishes a minor version with new features (x.MINOR.x).
.SH SEE ALSO
.nf
.fam C
Take a look at https://github.com/taskipy/taskipy?tab=readme-ov-file#readme for
more information on how to use Taskipy.
.fam T
.fi
.SH AUTHOR
.nf
.fam C
Taskipy was created by Josenilson Ferreira da Silva <nilsonfsilva@hotmail.com>.
Please visit https://github.com/taskipy/taskipy/issues for any issues related
to Taskipy.
.fam T
.fi
|
