Skip to content

Commit e531948

Browse files
tomvanmeletomvanmele
committed
update repo
1 parent 35d1091 commit e531948

File tree

14 files changed

+188
-486
lines changed

14 files changed

+188
-486
lines changed

‎.bumpversion.cfg‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎.editorconfig‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,23 @@ insert_final_newline = true
88
indent_style = space
99
indent_size = 4
1010
charset = utf-8
11-
max_line_length = 180
11+
max_line_length = 179
1212

1313
[*.{bat,cmd,ps1}]
1414
end_of_line = crlf
1515

1616
[*.md]
1717
trim_trailing_whitespace = false
1818

19+
[*.yml]
20+
indent_size = 2
21+
22+
[*.rst]
23+
indent_size = 4
24+
1925
[Makefile]
2026
indent_style = tab
2127
indent_size = 4
2228

23-
[*.yml]
24-
indent_style = space
25-
indent_size = 2
26-
2729
[LICENSE]
2830
insert_final_newline = false

‎CONTRIBUTING.md‎

Lines changed: 0 additions & 57 deletions
This file was deleted.

‎MANIFEST.in‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎README.md‎

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,21 @@
11
# COMPAS Triangle
22

3-
> [!WARNING]
4-
> This package is deprecated and will be removed in the future.
5-
> Please use [compas_cgal](https://github.com/compas-dev/compas_cgal) instead.
6-
73
COMPAS-firendly wrappers for the Triangle library.
84

9-
## Getting Started
5+
## Installation
106

11-
`compas_triangle` can be installed from PyPI.
7+
Stable releases can be installed from PyPI.
128

139
```bash
1410
pip install compas_triangle
1511
```
1612

17-
or from local source using pip
18-
19-
```bash
20-
pip install path/to/compas_triangle
21-
```
22-
23-
or directly from the github repo.
13+
To install the latest version for development, do:
2414

2515
```bash
26-
pip install git+https://github.com/blockresearchgroup/compas_triangle.git#egg=compas_triangle
16+
git clone https://github.com/blockresearchgroup/compas_triangle.git
17+
cd compas_triangle
18+
pip install -e ".[dev]"
2719
```
2820

2921
## License
@@ -34,15 +26,6 @@ The Cython wrapper is available here: <https://github.com/drufat/triangle>
3426
Use of the Triangle library is restricted to personal or academic purposes.
3527
The license of the library is included in this repo: [LICENSE.Triangle](LICENSE.Triangle)
3628

37-
## Examples
38-
39-
Four examples are available:
40-
41-
* examples/delaunay1.py
42-
* examples/delaunay2.py
43-
* examples/delaunay3.py
44-
* examples/delaunay4_rhino.py
45-
46-
Note that the Rhino example uses `compas.rpc` to provide a proxy for the package.
29+
## Issue Tracker
4730

48-
![Example delaunay3.py](examples/delaunay3.png)
31+
If you find a bug or if you have a problem with running the code, please file an issue on the [Issue Tracker](https://github.com/compas-dev/compas_triangle/issues).

‎pyproject.toml‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
[build-system]
2+
requires = ["setuptools>=66.0"]
3+
build-backend = "setuptools.build_meta"
4+
5+
# ============================================================================
6+
# project info
7+
# ============================================================================
8+
9+
[project]
10+
name = "compas_triangle"
11+
description = "COMPAS-firendly wrappers for the Triangle library"
12+
keywords = []
13+
authors = [
14+
{ name = "tom van mele", email = "tom.v.mele@gmail.com" },
15+
]
16+
license = { file = "LICENSE" }
17+
readme = "README.md"
18+
requires-python = ">=3.9"
19+
dynamic = ['dependencies', 'optional-dependencies', 'version']
20+
classifiers = [
21+
"Development Status :: 4 - Beta",
22+
"Topic :: Scientific/Engineering",
23+
"Operating System :: Unix",
24+
"Operating System :: POSIX",
25+
"Operating System :: Microsoft :: Windows",
26+
"Programming Language :: Python",
27+
"Programming Language :: Python :: 3",
28+
"Programming Language :: Python :: 3.10",
29+
"Programming Language :: Python :: 3.11",
30+
"Programming Language :: Python :: 3.12",
31+
]
32+
33+
[project.urls]
34+
Homepage = "https://compas-dev.github.io/compas_triangle"
35+
Documentation = "https://compas-dev.github.io/compas_triangle"
36+
Repository = "https://github.com/compas-dev/compas_triangle"
37+
Changelog = "https://github.com/compas-dev/compas_triangle/blob/main/CHANGELOG.md"
38+
Issues = "https://github.com/compas-dev/compas_triangle/issues"
39+
Forum = "https://forum.compas-framework.org/"
40+
41+
# ============================================================================
42+
# setuptools config
43+
# ============================================================================
44+
45+
[tool.setuptools]
46+
package-dir = { "" = "src" }
47+
include-package-data = true
48+
zip-safe = false
49+
50+
[tool.setuptools.dynamic]
51+
version = { attr = "compas_triangle.__version__" }
52+
dependencies = { file = "requirements.txt" }
53+
optional-dependencies = { dev = { file = "requirements-dev.txt" } }
54+
55+
[tool.setuptools.packages.find]
56+
where = ["src"]
57+
58+
# ============================================================================
59+
# replace pytest.ini
60+
# ============================================================================
61+
62+
[tool.pytest.ini_options]
63+
minversion = "6.0"
64+
testpaths = ["tests", "src/compas_triangle"]
65+
python_files = ["test_*.py", "*_test.py", "test.py"]
66+
addopts = [
67+
"-ra",
68+
"--strict-markers",
69+
"--doctest-glob=*.rst",
70+
"--tb=short",
71+
"--import-mode=importlib",
72+
]
73+
doctest_optionflags = [
74+
"NORMALIZE_WHITESPACE",
75+
"IGNORE_EXCEPTION_DETAIL",
76+
"ALLOW_UNICODE",
77+
"ALLOW_BYTES",
78+
"NUMBER",
79+
]
80+
81+
# ============================================================================
82+
# replace bumpversion.cfg
83+
# ============================================================================
84+
85+
[tool.bumpversion]
86+
current_version = "1.1.0"
87+
message = "Bump version to {new_version}"
88+
commit = true
89+
tag = true
90+
91+
[[tool.bumpversion.files]]
92+
filename = "src/compas_triangle/__init__.py"
93+
search = "{current_version}"
94+
replace = "{new_version}"
95+
96+
[[tool.bumpversion.files]]
97+
filename = "CHANGELOG.md"
98+
search = "Unreleased"
99+
replace = "[{new_version}] {now:%Y-%m-%d}"
100+
101+
# ============================================================================
102+
# replace setup.cfg
103+
# ============================================================================
104+
105+
[tool.black]
106+
line-length = 179
107+
108+
[tool.ruff]
109+
line-length = 179
110+
indent-width = 4
111+
target-version = "py39"
112+
113+
[tool.ruff.lint]
114+
select = ["E", "F", "I"]
115+
116+
[tool.ruff.lint.per-file-ignores]
117+
"__init__.py" = ["I001"]
118+
"tests/*" = ["I001"]
119+
"tasks.py" = ["I001"]
120+
121+
[tool.ruff.lint.isort]
122+
force-single-line = true
123+
known-first-party = ["compas_triangle"]
124+
125+
[tool.ruff.lint.pydocstyle]
126+
convention = "numpy"
127+
128+
[tool.ruff.lint.pycodestyle]
129+
max-doc-length = 179
130+
131+
[tool.ruff.format]
132+
docstring-code-format = true
133+
docstring-code-line-length = "dynamic"

‎pytest.ini‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎requirements-dev.txt‎

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,11 @@
1-
autopep8
21
attrs >=17.4
3-
bump2version >=0.5.11
4-
check-manifest >=0.36
5-
doc8
6-
flake8
7-
graphviz
2+
black >=22.12.0
3+
bump-my-version
4+
compas_invocations2
5+
compas_notebook
6+
compas_viewer
87
invoke >=0.14
9-
ipykernel
10-
ipython >=5.8
11-
isort
12-
m2r2
13-
nbsphinx
14-
pydocstyle
15-
pytest >=3.2
16-
sphinx_compas_theme >=0.13
17-
sphinx >=3.4
8+
ruff
9+
sphinx_compas2_theme
1810
twine
19-
-e .
11+
wheel

‎requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
triangle
2-
compas>=1.10
2+
compas >= 2.4

‎scripts/PLACEHOLDER‎

Whitespace-only changes.

0 commit comments

Comments
 (0)