Skip to content

Commit 883e98f

Browse files
ticdenisticdenis
committed
first commit
0 parents  commit 883e98f

11 files changed

Lines changed: 915 additions & 0 deletions

File tree

‎.editorconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# https://editorconfig.org
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
indent_size = 2
7+
indent_style = space
8+
insert_final_newline = true
9+
max_line_length = 120
10+
trim_trailing_whitespace = true
11+
12+
[{*.py}]
13+
indent_size = 4

‎.gitignore‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# External
2+
.DS_Store
3+
.idea/
4+
.vscode/
5+
*.iml
6+
7+
# Internal
8+
*.egg-info/
9+
*.pyc
10+
__pycache__/
11+
build/
12+
dist/
13+
requirements-dev.txt
14+
requirements.txt
15+
var/
16+
.venv/
17+
venv/

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 aiopy
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# 🚀 uvtask
2+
3+
[![PyPI version](https://badge.fury.io/py/uvtask.svg)](https://badge.fury.io/py/uvtask)
4+
[![PyPIDownloads](https://static.pepy.tech/badge/uvtask)](https://pepy.tech/project/uvtask)
5+
6+
**uvtask** is a modern, fast, and flexible Python task runner and test automation tool designed to simplify development workflows. It supports running, organizing, and managing tasks or tests in Python projects with an emphasis on ease of use and speed. ⚡
7+
8+
## 📦 Installation
9+
10+
```bash
11+
uv add --dev uvtask
12+
```
13+
14+
## 🎯 Quick Start
15+
16+
Run tasks defined in your `pyproject.toml`:
17+
18+
```shell
19+
uvx uvtask run <task_name>
20+
```
21+
22+
## 📝 Configuration
23+
24+
Define your tasks in `pyproject.toml` under the `[tool.run-script]` section:
25+
26+
```toml
27+
[tool.run-script]
28+
code-formatter = "uv run ruff format uvtask tests $@"
29+
"security-analysis:licenses" = "uv run pip-licenses"
30+
"security-analysis:vulnerabilities" = "uv run bandit -r -c pyproject.toml uvtask tests"
31+
"static-analysis:linter" = "uv run ruff check uvtask tests"
32+
"static-analysis:types" = "uv run ty check uvtask tests"
33+
test = "uv run pytest"
34+
unit-tests = "uv run pytest tests/unit"
35+
integration-tests = "uv run pytest tests/integration"
36+
functional-tests = "uv run pytest -n1 tests/functional"
37+
```
38+
39+
## 🛠️ Development
40+
41+
To run the development version:
42+
43+
```shell
44+
uvx --no-cache --from $PWD run --help
45+
```
46+
47+
## 📋 Requirements
48+
49+
- 🐍 Python >= 3.13
50+
51+
## 🤝 Contributing
52+
53+
Contributions are welcome! 🎉
54+
55+
- For major changes, please open an issue first to discuss what you would like to change
56+
- Make sure to update tests as appropriate
57+
- Follow the existing code style and conventions
58+
59+
## 📄 License
60+
61+
[MIT](https://github.com/aiopy/python-uvtask/blob/master/LICENSE) © uvtask contributors

‎pyproject.toml‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
[build-system]
2+
build-backend = "setuptools.build_meta"
3+
requires = ["setuptools"]
4+
5+
[project]
6+
authors = [
7+
{ name = "ticdenis", email = "navarrodenis940503@outlook.com" },
8+
]
9+
maintainers = [
10+
{ name = "ticdenis", email = "navarrodenis940503@outlook.com" }
11+
]
12+
classifiers = [
13+
"Intended Audience :: Information Technology",
14+
"Intended Audience :: System Administrators",
15+
"Operating System :: OS Independent",
16+
"Programming Language :: Python :: 3",
17+
"Programming Language :: Python",
18+
"Topic :: Software Development :: Libraries :: Python Modules",
19+
"Topic :: Software Development :: Libraries",
20+
"Topic :: Software Development",
21+
"Typing :: Typed",
22+
"Development Status :: 4 - Beta",
23+
"Intended Audience :: Developers",
24+
"License :: OSI Approved :: MIT License",
25+
"Programming Language :: Python :: 3 :: Only",
26+
"Programming Language :: Python :: 3.13",
27+
"Programming Language :: Python :: 3.14",
28+
]
29+
dependencies = []
30+
description = "uvtask is a modern, fast, and flexible Python task runner and test automation tool designed to simplify development workflows. It supports running, organizing, and managing tasks or tests in Python projects with an emphasis on ease of use and speed."
31+
dynamic = ["version"]
32+
keywords = [
33+
"uv",
34+
"uvx",
35+
"scripts",
36+
"tool",
37+
"pyproject",
38+
"task",
39+
"runner",
40+
]
41+
license = { text = "MIT" }
42+
name = "uvtask"
43+
readme = "README.md"
44+
requires-python = ">=3.13"
45+
46+
[dependency-groups]
47+
dev = [
48+
"bandit>=1.9.2",
49+
"pip-licenses>=5.5.0",
50+
"ruff>=0.14.10",
51+
"setuptools>=80.9.0",
52+
"twine>=6.2.0",
53+
"ty>=0.0.4",
54+
]
55+
56+
[project.urls]
57+
"documentation" = "https://aiopy.github.io/python-uvtask/"
58+
"repository" = "https://github.com/aiopy/python-uvtask"
59+
60+
[tool.setuptools.dynamic]
61+
version = { attr = "uvtask.__version__" }
62+
63+
[tool.setuptools.packages.find]
64+
include = ["uvtask*"]
65+
66+
[tool.setuptools.package-data]
67+
"uvtask" = ["py.typed"]
68+
69+
[[tool.uv.index]]
70+
url = "https://pypi.org/simple"
71+
72+
[tool.bandit]
73+
exclude_dirs = ["tests"]
74+
skips = ["B404", "B602"]
75+
76+
[tool.pip-licenses]
77+
allow-only = "Apache;BSD;MIT"
78+
ignore-packages = [
79+
]
80+
partial-match = true
81+
82+
[tool.ruff]
83+
cache-dir = "var/ruff"
84+
line-length = 140
85+
target-version = "py313"
86+
respect-gitignore = true
87+
fix = true
88+
lint.select = [
89+
"E", # pycodestyle errors
90+
"F", # pyflakes
91+
"W", # pycodestyle warnings
92+
"I", # isort
93+
"C90", # mccabe
94+
"N", # pep8-naming
95+
"PL", # pylint
96+
"RUF", # ruff-specific
97+
]
98+
lint.ignore = [
99+
]
100+
101+
[tool.ruff.format]
102+
quote-style = "preserve"
103+
indent-style = "space"
104+
skip-magic-trailing-comma = false
105+
line-ending = "auto"
106+
107+
[tool.ruff.lint.isort]
108+
combine-as-imports = true
109+
force-single-line = false
110+
known-first-party = ["uvtask"]
111+
112+
[tool.ruff.lint.mccabe]
113+
max-complexity = 15
114+
115+
[tool.ty.environment]
116+
python-version = "3.13"
117+
118+
[tool.ty.src]
119+
exclude = [
120+
"tests/fixtures/**",
121+
"var",
122+
]
123+
124+
[tool.run-script]
125+
install = "uv sync --frozen --no-dev"
126+
upgrade-install = "uv sync --frozen --no-dev --upgrade --refresh"
127+
dev-install = "uv sync --dev --all-extras"
128+
upgrade-dev-install = "uv sync --dev --all-extras --upgrade --refresh"
129+
deploy = "uv build && uv publish"
130+
docs = "python3 -m mkdocs build -f docs_src/config/en/mkdocs.yml && python3 -m mkdocs build -f docs_src/config/es/mkdocs.yml"
131+
dev-docs = "python3 -m mkdocs serve -f docs_src/config/en/mkdocs.yml"
132+
code-formatter = "uv run ruff format uvtask tests $@"
133+
"security-analysis:licenses" = "uv run pip-licenses"
134+
"security-analysis:vulnerabilities" = "uv run bandit -r -c pyproject.toml uvtask tests"
135+
"static-analysis:linter" = "uv run ruff check uvtask tests"
136+
"static-analysis:types" = "uv run ty check uvtask tests"
137+
clean = """python3 -c \"
138+
from glob import iglob
139+
from shutil import rmtree
140+
141+
for pathname in ['./build', './*.egg-info', './dist', './var', '**/__pycache__']:
142+
for path in iglob(pathname, recursive=True):
143+
rmtree(path, ignore_errors=True)
144+
\""""
145+
146+
[project.scripts]
147+
uvtask = "uvtask.cli:main"
148+
run = "uvtask.cli:main"
149+
run-script = "uvtask.cli:main"

‎tests/.gitkeep‎

Whitespace-only changes.

0 commit comments

Comments
 (0)