dssatlab 0.1.0__tar.gz

dssatlab-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, DSSATLab contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

dssatlab-0.1.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: dssatlab
+Version: 0.1.0
+Summary: Basic environment diagnostics for DSSATLab users.
+License-Expression: BSD-3-Clause
+Project-URL: Source, https://github.com/AbdelrahmanAmr3/dssatlab
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: build>=1; extra == "dev"
+Requires-Dist: twine>=6; extra == "dev"
+Dynamic: license-file
+
+# dssatlab
+
+DSSATLab 0.1.0 provides basic environment diagnostics for Python users preparing
+to work with DSSAT-CSM. It reports the operating system, machine architecture,
+and Python version with zero runtime dependencies. Requires Python 3.10 or newer.
+
+## Install and use
+
+```bash
+python -m pip install dssatlab
+```
+
+```python
+import dssatlab
+
+info = dssatlab.detect()
+print(info)
+print(info.os_name)
+```
+
+Example output on Linux:
+
+```text
+EnvironmentInfo(os_name='linux', architecture='x86_64', python_version='3.12.10')
+linux
+```
+
+`detect()` returns an immutable `EnvironmentInfo` dataclass:
+
+| Field | Meaning |
+| --- | --- |
+| `os_name` | Lowercase OS name, such as `windows`, `linux`, or `darwin` (macOS). |
+| `architecture` | Machine architecture as reported by Python, such as `AMD64`, `x86_64`, or `arm64`. |
+| `python_version` | Version of the running Python interpreter. |
+
+Unavailable OS or architecture values are reported as `unknown`. Importing the
+package and calling `detect()` do not prompt, download, or change files.
+
+This first release only reports the Python environment. DSSAT executable
+discovery, installation, connection, Colab detection, and simulation support
+are not implemented. No DSSAT software or data is bundled.
+
+## Source and development
+
+```text
+src/dssatlab/
+  __init__.py       # Public exports
+  core.py           # EnvironmentInfo and detect()
+tests/
+  test_detect.py    # OS normalization and unknown-platform cases
+pyproject.toml      # Package metadata and development dependencies
+.github/workflows/workflow.yml
+README.md
+LICENSE
+.gitignore
+```
+
+```bash
+python -m pip install -e '.[dev]'
+python -m pytest
+python -m build
+python -m twine check dist/*
+```
+
+## Release
+
+For a packaging check on GitHub, open **Actions > Publish to PyPI > Run workflow**
+and choose `master`, leaving **Publish the package to PyPI** unchecked. This runs
+tests, builds and validates the wheel and source archive, and saves them as an
+artifact. To retry a failed upload using updated workflow configuration, run
+the workflow with **Publish the package to PyPI** checked. This publishes the
+version in the selected source after all checks pass; it does not create a tag.
+
+To publish, update `version` in `pyproject.toml`, pass the tests and build checks,
+and commit the source. Publish a GitHub release using a new matching tag on that
+commit: version `0.1.0` uses tag `v0.1.0`. Publishing the release starts the PyPI
+workflow; saving a draft or pushing a tag alone does not. Development versions
+(`.dev`) are currently blocked by the workflow.
+
+The PyPI Trusted Publisher uses owner `AbdelrahmanAmr3`, repository `dssatlab`,
+workflow `workflow.yml`, and environment `pypi`. No API token is required.

dssatlab-0.1.0/README.md

@@ -0,0 +1,81 @@
+# dssatlab
+
+DSSATLab 0.1.0 provides basic environment diagnostics for Python users preparing
+to work with DSSAT-CSM. It reports the operating system, machine architecture,
+and Python version with zero runtime dependencies. Requires Python 3.10 or newer.
+
+## Install and use
+
+```bash
+python -m pip install dssatlab
+```
+
+```python
+import dssatlab
+
+info = dssatlab.detect()
+print(info)
+print(info.os_name)
+```
+
+Example output on Linux:
+
+```text
+EnvironmentInfo(os_name='linux', architecture='x86_64', python_version='3.12.10')
+linux
+```
+
+`detect()` returns an immutable `EnvironmentInfo` dataclass:
+
+| Field | Meaning |
+| --- | --- |
+| `os_name` | Lowercase OS name, such as `windows`, `linux`, or `darwin` (macOS). |
+| `architecture` | Machine architecture as reported by Python, such as `AMD64`, `x86_64`, or `arm64`. |
+| `python_version` | Version of the running Python interpreter. |
+
+Unavailable OS or architecture values are reported as `unknown`. Importing the
+package and calling `detect()` do not prompt, download, or change files.
+
+This first release only reports the Python environment. DSSAT executable
+discovery, installation, connection, Colab detection, and simulation support
+are not implemented. No DSSAT software or data is bundled.
+
+## Source and development
+
+```text
+src/dssatlab/
+  __init__.py       # Public exports
+  core.py           # EnvironmentInfo and detect()
+tests/
+  test_detect.py    # OS normalization and unknown-platform cases
+pyproject.toml      # Package metadata and development dependencies
+.github/workflows/workflow.yml
+README.md
+LICENSE
+.gitignore
+```
+
+```bash
+python -m pip install -e '.[dev]'
+python -m pytest
+python -m build
+python -m twine check dist/*
+```
+
+## Release
+
+For a packaging check on GitHub, open **Actions > Publish to PyPI > Run workflow**
+and choose `master`, leaving **Publish the package to PyPI** unchecked. This runs
+tests, builds and validates the wheel and source archive, and saves them as an
+artifact. To retry a failed upload using updated workflow configuration, run
+the workflow with **Publish the package to PyPI** checked. This publishes the
+version in the selected source after all checks pass; it does not create a tag.
+
+To publish, update `version` in `pyproject.toml`, pass the tests and build checks,
+and commit the source. Publish a GitHub release using a new matching tag on that
+commit: version `0.1.0` uses tag `v0.1.0`. Publishing the release starts the PyPI
+workflow; saving a draft or pushing a tag alone does not. Development versions
+(`.dev`) are currently blocked by the workflow.
+
+The PyPI Trusted Publisher uses owner `AbdelrahmanAmr3`, repository `dssatlab`,
+workflow `workflow.yml`, and environment `pypi`. No API token is required.

dssatlab-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dssatlab"
+version = "0.1.0"
+description = "Basic environment diagnostics for DSSATLab users."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "BSD-3-Clause"
+dependencies = []
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "build>=1", "twine>=6"]
+
+[project.urls]
+Source = "https://github.com/AbdelrahmanAmr3/dssatlab"
+
+[tool.setuptools.packages.find]
+where = ["src"]

dssatlab-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

dssatlab-0.1.0/src/dssatlab/__init__.py

@@ -0,0 +1,5 @@
+"""Basic environment diagnostics for DSSATLab users."""
+
+from .core import EnvironmentInfo, detect
+
+__all__ = ["EnvironmentInfo", "detect"]

dssatlab-0.1.0/src/dssatlab/core.py

@@ -0,0 +1,27 @@
+"""Report the local Python environment without changing it."""
+
+import platform
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class EnvironmentInfo:
+    """Operating system, machine architecture, and Python interpreter version."""
+
+    os_name: str
+    architecture: str
+    python_version: str
+
+
+def detect() -> EnvironmentInfo:
+    """Return environment details without prompts, downloads, or file changes.
+
+    OS names are lowercase (macOS is ``darwin``). Architecture uses the
+    platform's original spelling. Unavailable OS or architecture is ``unknown``.
+    This function does not search for or validate a DSSAT installation.
+    """
+    return EnvironmentInfo(
+        os_name=platform.system().lower() or "unknown",
+        architecture=platform.machine() or "unknown",
+        python_version=platform.python_version(),
+    )

dssatlab-0.1.0/src/dssatlab.egg-info/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: dssatlab
+Version: 0.1.0
+Summary: Basic environment diagnostics for DSSATLab users.
+License-Expression: BSD-3-Clause
+Project-URL: Source, https://github.com/AbdelrahmanAmr3/dssatlab
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: build>=1; extra == "dev"
+Requires-Dist: twine>=6; extra == "dev"
+Dynamic: license-file
+
+# dssatlab
+
+DSSATLab 0.1.0 provides basic environment diagnostics for Python users preparing
+to work with DSSAT-CSM. It reports the operating system, machine architecture,
+and Python version with zero runtime dependencies. Requires Python 3.10 or newer.
+
+## Install and use
+
+```bash
+python -m pip install dssatlab
+```
+
+```python
+import dssatlab
+
+info = dssatlab.detect()
+print(info)
+print(info.os_name)
+```
+
+Example output on Linux:
+
+```text
+EnvironmentInfo(os_name='linux', architecture='x86_64', python_version='3.12.10')
+linux
+```
+
+`detect()` returns an immutable `EnvironmentInfo` dataclass:
+
+| Field | Meaning |
+| --- | --- |
+| `os_name` | Lowercase OS name, such as `windows`, `linux`, or `darwin` (macOS). |
+| `architecture` | Machine architecture as reported by Python, such as `AMD64`, `x86_64`, or `arm64`. |
+| `python_version` | Version of the running Python interpreter. |
+
+Unavailable OS or architecture values are reported as `unknown`. Importing the
+package and calling `detect()` do not prompt, download, or change files.
+
+This first release only reports the Python environment. DSSAT executable
+discovery, installation, connection, Colab detection, and simulation support
+are not implemented. No DSSAT software or data is bundled.
+
+## Source and development
+
+```text
+src/dssatlab/
+  __init__.py       # Public exports
+  core.py           # EnvironmentInfo and detect()
+tests/
+  test_detect.py    # OS normalization and unknown-platform cases
+pyproject.toml      # Package metadata and development dependencies
+.github/workflows/workflow.yml
+README.md
+LICENSE
+.gitignore
+```
+
+```bash
+python -m pip install -e '.[dev]'
+python -m pytest
+python -m build
+python -m twine check dist/*
+```
+
+## Release
+
+For a packaging check on GitHub, open **Actions > Publish to PyPI > Run workflow**
+and choose `master`, leaving **Publish the package to PyPI** unchecked. This runs
+tests, builds and validates the wheel and source archive, and saves them as an
+artifact. To retry a failed upload using updated workflow configuration, run
+the workflow with **Publish the package to PyPI** checked. This publishes the
+version in the selected source after all checks pass; it does not create a tag.
+
+To publish, update `version` in `pyproject.toml`, pass the tests and build checks,
+and commit the source. Publish a GitHub release using a new matching tag on that
+commit: version `0.1.0` uses tag `v0.1.0`. Publishing the release starts the PyPI
+workflow; saving a draft or pushing a tag alone does not. Development versions
+(`.dev`) are currently blocked by the workflow.
+
+The PyPI Trusted Publisher uses owner `AbdelrahmanAmr3`, repository `dssatlab`,
+workflow `workflow.yml`, and environment `pypi`. No API token is required.

dssatlab-0.1.0/src/dssatlab.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/dssatlab/__init__.py
+src/dssatlab/core.py
+src/dssatlab.egg-info/PKG-INFO
+src/dssatlab.egg-info/SOURCES.txt
+src/dssatlab.egg-info/dependency_links.txt
+src/dssatlab.egg-info/requires.txt
+src/dssatlab.egg-info/top_level.txt
+tests/test_detect.py

dssatlab-0.1.0/src/dssatlab.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dssatlab-0.1.0/src/dssatlab.egg-info/requires.txt

@@ -0,0 +1,5 @@
+
+[dev]
+pytest>=8
+build>=1
+twine>=6

dssatlab-0.1.0/src/dssatlab.egg-info/top_level.txt

@@ -0,0 +1 @@
+dssatlab

dssatlab-0.1.0/tests/test_detect.py

@@ -0,0 +1,32 @@
+"""Check environment reporting without depending on the test runner's OS."""
+
+import platform
+
+import pytest
+
+import dssatlab
+
+
+@pytest.mark.parametrize(
+    "system, machine, expected_os, expected_architecture",
+    [
+        ("Windows", "AMD64", "windows", "AMD64"),
+        ("Windows", "ARM64", "windows", "ARM64"),
+        ("Linux", "x86_64", "linux", "x86_64"),
+        ("Darwin", "arm64", "darwin", "arm64"),
+        ("FreeBSD", "amd64", "freebsd", "amd64"),
+        ("", "", "unknown", "unknown"),
+    ],
+)
+def test_detect_normalizes_os_and_handles_unknown_platform(
+    monkeypatch, system, machine, expected_os, expected_architecture
+):
+    monkeypatch.setattr(platform, "system", lambda: system)
+    monkeypatch.setattr(platform, "machine", lambda: machine)
+    monkeypatch.setattr(platform, "python_version", lambda: "3.12.10")
+
+    info = dssatlab.detect()
+
+    assert info.os_name == expected_os
+    assert info.architecture == expected_architecture
+    assert info.python_version == "3.12.10"