Skip to content

Commit ff52068

Browse files
artemisTurintechpaulsbrookes
authored andcommitted
docs: add comprehensive testing suite and documentation with pytest framework, unit/integration tests, usage guide, algorithm docs, and example configs
BREAKING CHANGE: README.md completely rewritten from template to comprehensive clustering toolkit
1 parent b5783fd commit ff52068

17 files changed

+2778
-23
lines changed

README.md

Lines changed: 502 additions & 23 deletions
Large diffs are not rendered by default.

pyproject.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,11 @@ dependencies = [
1313
"pyyaml>=6.0.0",
1414
]
1515

16+
[project.optional-dependencies]
17+
dev = [
18+
"pytest>=7.4.0",
19+
"pytest-cov>=4.1.0",
20+
]
21+
1622
[project.scripts]
1723
clustering-toolkit = "main:main"

tests/__init__.py

Whitespace-only changes.

tests/fixtures/__init__.py

Whitespace-only changes.

tests/fixtures/empty.csv

Whitespace-only changes.

tests/fixtures/headers_only.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
x,y,z

tests/fixtures/medium_dataset.csv

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
x,y,z
2+
1.0,1.0,1.0
3+
1.2,1.1,1.3
4+
1.5,1.3,1.2
5+
1.8,1.6,1.4
6+
2.0,1.8,1.6
7+
10.0,10.0,10.0
8+
10.2,10.1,10.3
9+
10.5,10.3,10.2
10+
10.8,10.6,10.4
11+
11.0,10.8,10.6
12+
20.0,20.0,20.0
13+
20.2,20.1,20.3
14+
20.5,20.3,20.2
15+
20.8,20.6,20.4
16+
21.0,20.8,20.6

tests/fixtures/non_numeric.csv

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
id,name,value
2+
1,apple,10.0
3+
2,banana,20.0
4+
3,cherry,30.0

tests/fixtures/simple_2d.csv

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
x,y
2+
1.0,1.0
3+
1.5,1.2
4+
1.3,1.5
5+
2.0,1.8
6+
10.0,10.0
7+
10.5,10.2
8+
10.3,10.5
9+
11.0,11.0

tests/fixtures/with_missing.csv

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
feature1,feature2,feature3
2+
1.0,2.0,3.0
3+
4.0,,6.0
4+
7.0,8.0,9.0
5+
10.0,11.0,
6+
13.0,14.0,15.0

0 commit comments

Comments
 (0)