Add comprehensive documentation and examples
- docs/USAGE.md: Full usage guide with CLI options, Python API, troubleshooting - docs/ATOMIZER_INTEGRATION.md: Guide for FEA/Atomizer integration - examples/sample_config.toml: Annotated configuration example - README.md: Expanded with installation, usage, architecture
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "cad-documenter"
|
||||
version = "0.1.0"
|
||||
version = "0.2.0"
|
||||
description = "Video walkthrough → Complete engineering documentation"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.12"
|
||||
@@ -8,26 +8,48 @@ license = {text = "MIT"}
|
||||
authors = [
|
||||
{name = "Antoine Letarte", email = "antoine.letarte@gmail.com"},
|
||||
]
|
||||
keywords = ["cad", "documentation", "engineering", "video", "ai", "vision", "whisper"]
|
||||
classifiers = [
|
||||
"Development Status :: 4 - Beta",
|
||||
"Intended Audience :: Developers",
|
||||
"Intended Audience :: Manufacturing",
|
||||
"Intended Audience :: Science/Research",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Topic :: Scientific/Engineering",
|
||||
"Topic :: Multimedia :: Video",
|
||||
]
|
||||
|
||||
dependencies = [
|
||||
"click>=8.1.0",
|
||||
"rich>=13.0.0",
|
||||
"pydantic>=2.0.0",
|
||||
"jinja2>=3.1.0",
|
||||
"openai-whisper>=20231117",
|
||||
"pillow>=10.0.0",
|
||||
"httpx>=0.27.0",
|
||||
"tomli>=2.0.0;python_version<'3.11'",
|
||||
# Vision API clients
|
||||
"anthropic>=0.40.0",
|
||||
"openai>=1.50.0",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"pytest>=8.0.0",
|
||||
"pytest-cov>=4.0.0",
|
||||
"ruff>=0.1.0",
|
||||
"mypy>=1.0.0",
|
||||
]
|
||||
pdf = [
|
||||
"pandoc", # For PDF generation fallback
|
||||
]
|
||||
|
||||
[project.scripts]
|
||||
cad-doc = "cad_documenter.cli:main"
|
||||
|
||||
[project.urls]
|
||||
Homepage = "http://100.80.199.40:3000/Antoine/CAD-Documenter"
|
||||
Documentation = "http://100.80.199.40:3000/Antoine/CAD-Documenter"
|
||||
Repository = "http://100.80.199.40:3000/Antoine/CAD-Documenter"
|
||||
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
@@ -38,3 +60,17 @@ packages = ["src/cad_documenter"]
|
||||
[tool.ruff]
|
||||
line-length = 100
|
||||
target-version = "py312"
|
||||
|
||||
[tool.ruff.lint]
|
||||
select = ["E", "F", "I", "UP"]
|
||||
ignore = ["E501"] # Line length handled separately
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
testpaths = ["tests"]
|
||||
pythonpath = ["src"]
|
||||
|
||||
[tool.mypy]
|
||||
python_version = "3.12"
|
||||
strict = false
|
||||
warn_return_any = true
|
||||
warn_unused_ignores = true
|
||||
|
||||
Reference in New Issue
Block a user