endia 0.0.1__tar.gz

endia-0.0.1/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+.venv-*/
+dist/
+__pycache__/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/

endia-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

endia-0.0.1/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.5
+Name: endia
+Version: 0.0.1
+Summary: Client for EastIndia, which runs Windows desktop test machines that tests drive like Docker containers. Early preview.
+Author: teaToolkit
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: cattrs>=24.1
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: websockets>=15
+Description-Content-Type: text/markdown
+
+# endia
+
+Client for EastIndia, which runs Windows desktop test machines that tests drive like Docker containers. Early preview: the product is not released yet.
+
+The package needs Python 3.10 or later and is imported as `endia`. It calls the EastIndia service's HTTPS API, so a test written in Python can build images, bring fleets of machines up and down, and run programs in them without the `endia` command line.
+
+## Example
+
+```python
+from endia import EastIndiaClient
+
+# Connects where the endia command line would: EASTINDIA_HOST and EASTINDIA_CERT_PATH, or its current context.
+with EastIndiaClient.from_env() as client:
+	print(client.version().version)
+
+	built = client.images.build("lab-image", tags=["lab/dotnet:10"]).result()
+	print(built.digest)
+
+	result = client.execs.run("classroom-server-1", ["cmd", "/c", "exit 3010"])
+	assert result.exit_code == 3010
+```

endia-0.0.1/README.md

@@ -0,0 +1,21 @@
+# endia
+
+Client for EastIndia, which runs Windows desktop test machines that tests drive like Docker containers. Early preview: the product is not released yet.
+
+The package needs Python 3.10 or later and is imported as `endia`. It calls the EastIndia service's HTTPS API, so a test written in Python can build images, bring fleets of machines up and down, and run programs in them without the `endia` command line.
+
+## Example
+
+```python
+from endia import EastIndiaClient
+
+# Connects where the endia command line would: EASTINDIA_HOST and EASTINDIA_CERT_PATH, or its current context.
+with EastIndiaClient.from_env() as client:
+	print(client.version().version)
+
+	built = client.images.build("lab-image", tags=["lab/dotnet:10"]).result()
+	print(built.digest)
+
+	result = client.execs.run("classroom-server-1", ["cmd", "/c", "exit 3010"])
+	assert result.exit_code == 3010
+```

endia-0.0.1/hatch_build.py

@@ -0,0 +1,57 @@
+"""Gives the package EastIndia's own version, by the rule the repository's build program applies.
+
+``Directory.Build.props`` at the repository's root holds ``EastIndiaVersion``, major.minor.patch. The patch is the version of the
+commit that wrote that line; each later commit adds one to it, so every build is higher than the one before. A version written but
+not yet committed is used as written.
+
+A source distribution holds no repository. Its ``PKG-INFO`` already carries the version worked out when it was made, and a wheel
+built from it takes that version.
+"""
+
+import re
+import subprocess
+from email.parser import Parser
+from pathlib import Path
+from typing import Any
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+
+_PROPS = "Directory.Build.props"
+_VERSION = re.compile(r"<EastIndiaVersion>\s*(\d+)\.(\d+)\.(\d+)\s*</EastIndiaVersion>")
+
+
+class EastIndiaVersionHook(MetadataHookInterface):
+	"""Sets the package's version from the repository, or from ``PKG-INFO`` in a source distribution."""
+
+	def update(self, metadata: dict[str, Any]) -> None:
+		root = Path(self.root)
+		packaged = root / "PKG-INFO"
+		metadata["version"] = (
+			Parser().parsestr(packaged.read_text(encoding="utf-8"))["Version"] if packaged.is_file() else eastindia_version(root)
+		)
+
+
+def eastindia_version(package_root: Path) -> str:
+	"""Works out the version from the repository that holds the package."""
+	repository = Path(_git(package_root, "rev-parse", "--show-toplevel"))
+	written = _read((repository / _PROPS).read_text(encoding="utf-8"))
+	if written is None:
+		raise ValueError(f"{_PROPS} has no EastIndiaVersion of the form major.minor.patch.")
+	committed = _read(_git(repository, "show", f"HEAD:{_PROPS}"))
+	later = _commits_since_version_written(repository) if committed == written else 0
+	major, minor, patch = written
+	return f"{major}.{minor}.{patch + later}"
+
+
+def _commits_since_version_written(repository: Path) -> int:
+	commit = _git(repository, "log", "-1", "--format=%H", "-G<EastIndiaVersion>", "--", _PROPS)
+	return int(_git(repository, "rev-list", "--count", f"{commit}..HEAD"))
+
+
+def _read(props: str) -> tuple[int, int, int] | None:
+	match = _VERSION.search(props)
+	return (int(match[1]), int(match[2]), int(match[3])) if match else None
+
+
+def _git(folder: Path, *arguments: str) -> str:
+	return subprocess.run(["git", *arguments], cwd=folder, capture_output=True, text=True, check=True).stdout.strip()

endia-0.0.1/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "endia"
+version = "0.0.1"
+description = "Client for EastIndia, which runs Windows desktop test machines that tests drive like Docker containers. Early preview."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "teaToolkit" }]
+dependencies = [
+	"cattrs>=24.1",
+	"httpx>=0.27,<1",
+	"websockets>=15",
+]
+classifiers = [
+	"Development Status :: 2 - Pre-Alpha",
+	"Programming Language :: Python :: 3",
+	"Typing :: Typed",
+]
+
+[dependency-groups]
+test = [
+	"aiohttp>=3.10",
+	"cryptography>=43",
+	"pytest>=8",
+]
+lint = [
+	"mypy>=1.13",
+	"ruff>=0.8",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/endia"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src", "README.md", "pyproject.toml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = ["live: needs the EastIndia service; runs only when EASTINDIA_LIVE=1"]
+addopts = "--strict-markers"
+filterwarnings = ["error"]
+
+[tool.mypy]
+strict = true
+python_version = "3.10"
+files = ["src", "tests"]
+
+[tool.ruff]
+line-length = 140
+target-version = "py310"
+include = ["src/**/*.py", "tests/**/*.py", "hatch_build.py"]
+
+[tool.ruff.format]
+indent-style = "tab"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "SIM", "RUF", "PL", "PT", "N"]
+ignore = [
+	"W191",    # tabs indent the code, as in every EastIndia source file
+	"E501",    # the formatter decides line length
+	"PLR0913", # a route's options are keyword arguments, as many as the route has
+	"PLR2004", # tests compare with literal expected values
+	"E731",    # a short lambda reads better than a nested def in one place
+]

endia-0.0.1/src/endia/__init__.py

@@ -0,0 +1,52 @@
+"""The Python client of EastIndia, which runs Hyper-V Windows virtual machines for tests, driven as Docker drives containers.
+
+Start from ``EastIndiaClient``, or ``EastIndiaClient.from_env()`` to connect where the ``endia`` CLI would. The records of
+each area live in the area's module, such as ``endia.desktop.UiElement``.
+"""
+
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as _version
+
+from ._dockerignore import IgnoreFileError
+from ._wire import Timestamp
+from .client import EastIndiaClient
+from .errors import (
+	ApiError,
+	ConnectionFailure,
+	EastIndiaApiError,
+	EastIndiaConnectionError,
+	EastIndiaError,
+	ErrorCode,
+	ExecTimeoutError,
+	MachineFailedError,
+	OperationFailedError,
+)
+from .execs import ExecResult, ExecSession, StreamKind
+from .operations import Operation, OperationHandle, OperationState
+
+try:
+	__version__ = _version("endia")
+except PackageNotFoundError:
+	__version__ = "0.0.0"
+
+__all__ = [
+	"ApiError",
+	"ConnectionFailure",
+	"EastIndiaApiError",
+	"EastIndiaClient",
+	"EastIndiaConnectionError",
+	"EastIndiaError",
+	"ErrorCode",
+	"ExecResult",
+	"ExecSession",
+	"ExecTimeoutError",
+	"IgnoreFileError",
+	"MachineFailedError",
+	"Operation",
+	"OperationFailedError",
+	"OperationHandle",
+	"OperationState",
+	"StreamKind",
+	"Timestamp",
+	"__version__",
+]