Skip to content

Commit 622aff5

Browse files
committed
chore(docs): purge sphinx documentation and related dependencies
1 parent 3e671b8 commit 622aff5

File tree

44 files changed

+102
-2001
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+102
-2001
lines changed

poetry.lock

Lines changed: 7 additions & 294 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 95 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ homepage = "https://airbyte.com"
1313
repository = "https://github.com/airbytehq/airbyte-python-cdk"
1414
documentation = "https://docs.airbyte.io/"
1515
classifiers = [
16-
"Development Status :: 3 - Alpha",
17-
"Intended Audience :: Developers",
18-
"Topic :: Scientific/Engineering",
19-
"Topic :: Software Development :: Libraries :: Python Modules",
20-
"License :: OSI Approved :: MIT License",
21-
"Programming Language :: Python :: 3.10",
16+
"Development Status :: 3 - Alpha",
17+
"Intended Audience :: Developers",
18+
"Topic :: Scientific/Engineering",
19+
"Topic :: Software Development :: Libraries :: Python Modules",
20+
"License :: OSI Approved :: MIT License",
21+
"Programming Language :: Python :: 3.10",
2222
]
2323
keywords = ["airbyte", "connector-development-kit", "cdk"]
2424

2525
# Python CDK uses dynamic versioning: https://github.com/mtkennerly/poetry-dynamic-versioning
26-
version = "0.0.0" # Version will be calculated dynamically.
26+
version = "0.0.0" # Version will be calculated dynamically.
2727

2828
[tool.poetry-dynamic-versioning]
2929
enable = true
@@ -39,7 +39,7 @@ genson = "1.3.0"
3939
isodate = "~0.6.1"
4040
Jinja2 = "~3.1.2"
4141
jsonref = "~0.2"
42-
jsonschema = "~4.17.3" # 4.18 has some significant breaking changes: https://github.com/python-jsonschema/jsonschema/releases/tag/v4.18.0
42+
jsonschema = "~4.17.3" # 4.18 has some significant breaking changes: https://github.com/python-jsonschema/jsonschema/releases/tag/v4.18.0
4343
pandas = "2.2.2"
4444
pendulum = "<3.0.0"
4545
psutil = "6.1.0"
@@ -66,21 +66,22 @@ pyarrow = { version = "~15.0.0", optional = true }
6666
pytesseract = { version = "0.3.10", optional = true }
6767
python-calamine = { version = "0.2.3", optional = true }
6868
python-snappy = { version = "0.7.3", optional = true }
69-
Sphinx = { version = "~4.2", optional = true }
70-
sphinx-rtd-theme = { version = "~1.0", optional = true }
7169
tiktoken = { version = "0.8.0", optional = true }
7270
nltk = { version = "3.9.1", optional = true }
7371
# This will ensure that even when you run poetry install or pip install, the compatible version of numpy will always be chosen.
7472
# airbyte-ci will try to install latest version when --use-local-cdk is used, resulting in the conflict.
7573
numpy = "<2"
76-
unstructured = { version = "0.10.27", extras = ["docx", "pptx"], optional = true }
74+
unstructured = { version = "0.10.27", extras = [
75+
"docx",
76+
"pptx",
77+
], optional = true }
7778
"unstructured.pytesseract" = { version = ">=0.3.12", optional = true }
7879
pyjwt = "^2.8.0"
7980
cryptography = ">=42.0.5,<44.0.0"
8081
pytz = "2024.1"
8182
orjson = "^3.10.7"
8283
serpyco-rs = "^1.10.2"
83-
sqlalchemy = {version = "^2.0,!=2.0.36", optional = true }
84+
sqlalchemy = { version = "^2.0,!=2.0.36", optional = true }
8485
xmltodict = "^0.13.0"
8586

8687
[tool.poetry.group.dev.dependencies]
@@ -105,8 +106,19 @@ types-pyyaml = "^6.0.12.20240917"
105106
types-cachetools = "^5.5.0.20240820"
106107

107108
[tool.poetry.extras]
108-
file-based = ["avro", "fastavro", "pyarrow", "unstructured", "pdf2image", "pdfminer.six", "unstructured.pytesseract", "pytesseract", "markdown", "python-calamine", "python-snappy"]
109-
sphinx-docs = ["Sphinx", "sphinx-rtd-theme"]
109+
file-based = [
110+
"avro",
111+
"fastavro",
112+
"pyarrow",
113+
"unstructured",
114+
"pdf2image",
115+
"pdfminer.six",
116+
"unstructured.pytesseract",
117+
"pytesseract",
118+
"markdown",
119+
"python-calamine",
120+
"python-snappy",
121+
]
110122
vector-db-based = ["langchain", "openai", "cohere", "tiktoken"]
111123
sql = ["sqlalchemy"]
112124

@@ -115,10 +127,14 @@ sql = ["sqlalchemy"]
115127
source-declarative-manifest = "airbyte_cdk.cli.source_declarative_manifest:run"
116128

117129
[tool.isort]
118-
skip = ["__init__.py"] # TODO: Remove after this is fixed: https://github.com/airbytehq/airbyte-python-cdk/issues/12
130+
skip = [
131+
"__init__.py",
132+
] # TODO: Remove after this is fixed: https://github.com/airbytehq/airbyte-python-cdk/issues/12
119133

120134
[tool.ruff]
121-
exclude = ["__init__.py"] # TODO: Remove after this is fixed: https://github.com/airbytehq/airbyte-python-cdk/issues/12
135+
exclude = [
136+
"__init__.py",
137+
] # TODO: Remove after this is fixed: https://github.com/airbytehq/airbyte-python-cdk/issues/12
122138

123139
target-version = "py310"
124140
line-length = 100
@@ -128,76 +144,110 @@ select = ["I"]
128144

129145
[tool.poe.tasks]
130146
# Build tasks
131-
assemble = {cmd = "bin/generate-component-manifest-dagger.sh", help = "Generate component manifest files."}
132-
build-package = {cmd = "poetry build", help = "Build the python package: source and wheels archives."}
133-
build = {sequence = ["assemble", "build-package"], help = "Run all tasks to build the package."}
147+
assemble = { cmd = "bin/generate-component-manifest-dagger.sh", help = "Generate component manifest files." }
148+
build-package = { cmd = "poetry build", help = "Build the python package: source and wheels archives." }
149+
build = { sequence = [
150+
"assemble",
151+
"build-package",
152+
], help = "Run all tasks to build the package." }
134153

135154
# Format check tasks
136-
_format-check-ruff = {cmd = "ruff format --check .", help = "Check formatting with Ruff."}
137-
_format-check-prettier = {cmd = "npx prettier . --check", help = "Check formatting with prettier."}
138-
format-check = {sequence = ["_format-check-ruff", "_format-check-prettier"], help = "Check formatting for all file types.", ignore_fail = "return_non_zero"}
155+
_format-check-ruff = { cmd = "ruff format --check .", help = "Check formatting with Ruff." }
156+
_format-check-prettier = { cmd = "npx prettier . --check", help = "Check formatting with prettier." }
157+
format-check = { sequence = [
158+
"_format-check-ruff",
159+
"_format-check-prettier",
160+
], help = "Check formatting for all file types.", ignore_fail = "return_non_zero" }
139161

140162
# Format fix tasks
141-
_format-fix-ruff = {cmd = "ruff format .", help = "Format with Ruff."}
142-
_format-fix-prettier = {cmd = "npx prettier . --write", help = "Format with prettier."}
143-
format-fix = {sequence = ["_format-fix-ruff", "_format-fix-prettier"], help = "Format all file types.", ignore_fail = "return_non_zero"}
163+
_format-fix-ruff = { cmd = "ruff format .", help = "Format with Ruff." }
164+
_format-fix-prettier = { cmd = "npx prettier . --write", help = "Format with prettier." }
165+
format-fix = { sequence = [
166+
"_format-fix-ruff",
167+
"_format-fix-prettier",
168+
], help = "Format all file types.", ignore_fail = "return_non_zero" }
144169

145170
# Linting/Typing check tasks
146-
_lint-ruff = {cmd = "poetry run ruff check .", help = "Lint with Ruff."}
147-
type-check = {cmd = "poetry run mypy airbyte_cdk", help = "Type check modified files with mypy."}
148-
lint = {sequence = ["_lint-ruff", "type-check"], help = "Lint all code. Includes type checking.", ignore_fail = "return_non_zero"}
171+
_lint-ruff = { cmd = "poetry run ruff check .", help = "Lint with Ruff." }
172+
type-check = { cmd = "poetry run mypy airbyte_cdk", help = "Type check modified files with mypy." }
173+
lint = { sequence = [
174+
"_lint-ruff",
175+
"type-check",
176+
], help = "Lint all code. Includes type checking.", ignore_fail = "return_non_zero" }
149177

150178
# Lockfile check task
151-
check-lockfile = {cmd = "poetry check", help = "Check the poetry lock file."}
179+
check-lockfile = { cmd = "poetry check", help = "Check the poetry lock file." }
152180

153181
# Linting/Typing fix tasks
154182
lint-fix = { cmd = "poetry run ruff check --fix .", help = "Auto-fix any lint issues that Ruff can automatically resolve (excluding 'unsafe' fixes)." }
155183
lint-fix-unsafe = { cmd = "poetry run ruff check --fix --unsafe-fixes .", help = "Lint-fix modified files, including 'unsafe' fixes. It is recommended to first commit any pending changes and then always manually review any unsafe changes applied." }
156184

157185
# Combined Check and Fix tasks
158186

159-
check-all = {sequence = ["lint", "format-check", "type-check", "check-lockfile"], help = "Lint, format, and type-check modified files.", ignore_fail = "return_non_zero"}
160-
fix-all = {sequence = ["format-fix", "lint-fix"], help = "Lint-fix and format-fix modified files, ignoring unsafe fixes.", ignore_fail = "return_non_zero"}
161-
fix-and-check = {sequence = ["fix-all", "check-all"], help = "Lint-fix and format-fix, then re-check to see if any issues remain.", ignore_fail = "return_non_zero"}
187+
check-all = { sequence = [
188+
"lint",
189+
"format-check",
190+
"type-check",
191+
"check-lockfile",
192+
], help = "Lint, format, and type-check modified files.", ignore_fail = "return_non_zero" }
193+
fix-all = { sequence = [
194+
"format-fix",
195+
"lint-fix",
196+
], help = "Lint-fix and format-fix modified files, ignoring unsafe fixes.", ignore_fail = "return_non_zero" }
197+
fix-and-check = { sequence = [
198+
"fix-all",
199+
"check-all",
200+
], help = "Lint-fix and format-fix, then re-check to see if any issues remain.", ignore_fail = "return_non_zero" }
162201

163202
# PyTest tasks
164203

165-
pytest = {cmd = "poetry run coverage run -m pytest --durations=10", help = "Run all pytest tests."}
166-
pytest-fast = {cmd = "poetry run coverage run -m pytest --durations=5 --exitfirst -m 'not flaky and not slow and not requires_creds'", help = "Run pytest tests, failing fast and excluding slow tests."}
167-
unit-test-with-cov = {cmd = "pytest -s unit_tests --cov=airbyte_cdk --cov-report=term --cov-config ./pyproject.toml", help = "Run unit tests and create a coverage report."}
204+
pytest = { cmd = "poetry run coverage run -m pytest --durations=10", help = "Run all pytest tests." }
205+
pytest-fast = { cmd = "poetry run coverage run -m pytest --durations=5 --exitfirst -m 'not flaky and not slow and not requires_creds'", help = "Run pytest tests, failing fast and excluding slow tests." }
206+
unit-test-with-cov = { cmd = "pytest -s unit_tests --cov=airbyte_cdk --cov-report=term --cov-config ./pyproject.toml", help = "Run unit tests and create a coverage report." }
168207

169208
# Combined check tasks (other)
170209

171210
# TODO: find a version of the modified mypy check that works both locally and in CI.
172-
check-local = {sequence = ["lint", "type-check", "check-lockfile", "unit-test-with-cov"], help = "Lint all code, type-check modified files, and run unit tests."}
173-
check-ci = {sequence = ["check-lockfile", "build", "lint", "unit-test-with-cov"], help = "Build the package, lint and run unit tests. Does not include type-checking."}
211+
check-local = { sequence = [
212+
"lint",
213+
"type-check",
214+
"check-lockfile",
215+
"unit-test-with-cov",
216+
], help = "Lint all code, type-check modified files, and run unit tests." }
217+
check-ci = { sequence = [
218+
"check-lockfile",
219+
"build",
220+
"lint",
221+
"unit-test-with-cov",
222+
], help = "Build the package, lint and run unit tests. Does not include type-checking." }
174223

175224
# Build and check
176-
pre-push = {sequence = ["build", "check-local"], help = "Run all build and check tasks."}
225+
pre-push = { sequence = [
226+
"build",
227+
"check-local",
228+
], help = "Run all build and check tasks." }
177229

178230
# API Docs with PDoc
179-
docs-generate = {env = {PDOC_ALLOW_EXEC = "1"}, cmd = "python -m docs.generate run", help="Generate API documentation with PDoc."}
180-
docs-preview = {shell = "poe docs-generate && open docs/generated/index.html", help="Generate API documentation with PDoc and then open the docs in the default web browser."}
231+
docs-generate = { env = { PDOC_ALLOW_EXEC = "1" }, cmd = "python -m docs.generate run", help = "Generate API documentation with PDoc." }
232+
docs-preview = { shell = "poe docs-generate && open docs/generated/index.html", help = "Generate API documentation with PDoc and then open the docs in the default web browser." }
181233

182234
[tool.check-wheel-contents]
183235
# Quality control for Python wheel generation. Docs here:
184236
# - https://github.com/jwodder/check-wheel-contents
185237
ignore = [
186-
"W002" # Duplicate files. (TODO: Fix the few duplicate files, mostly `__init__.py` files that have only copyright text.)
238+
"W002", # Duplicate files. (TODO: Fix the few duplicate files, mostly `__init__.py` files that have only copyright text.)
187239
]
188240

189241
[tool.pytest.ini_options]
190242
log_cli = true
191243
log_cli_level = "INFO"
192244
log_cli_format = "%(asctime)s [%(levelname)8s] %(message)s (%(filename)s:%(lineno)s)"
193245
log_cli_date_format = "%Y-%m-%d %H:%M:%S"
194-
filterwarnings = [
195-
"ignore::airbyte_cdk.sources.source.ExperimentalClassWarning"
196-
]
246+
filterwarnings = ["ignore::airbyte_cdk.sources.source.ExperimentalClassWarning"]
197247

198248
[tool.airbyte_ci]
199249
python_versions = ["3.10", "3.11"]
200250
optional_poetry_groups = ["dev"]
201-
poetry_extras = ["file-based", "sphinx-docs", "vector-db-based"]
251+
poetry_extras = ["file-based", "vector-db-based"]
202252
poe_tasks = ["check-ci"]
203253
mount_docker_socket = true

reference_docs/Makefile

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

reference_docs/_source/api/airbyte_cdk.destinations.rst

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

reference_docs/_source/api/airbyte_cdk.models.rst

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

reference_docs/_source/api/airbyte_cdk.rst

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

reference_docs/_source/api/airbyte_cdk.sources.declarative.auth.rst

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

0 commit comments

Comments
 (0)