fundamental-client 0.2.3__tar.gz → 0.2.4__tar.gz

fundamental_client-0.2.4/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.2.4"
+}

{fundamental_client-0.2.3 → fundamental_client-0.2.4}/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 <!-- version list -->
 
+## [0.2.4](https://github.com/Fundamental-Technologies/fundamental-client/compare/0.2.3...0.2.4) (2026-02-04)
+
+
+### Bug Fixes
+
+* eng-575-user-facing-readme ([#64](https://github.com/Fundamental-Technologies/fundamental-client/issues/64)) ([591bcce](https://github.com/Fundamental-Technologies/fundamental-client/commit/591bccefed4abeaeddca9b8a03d81044d2d4bb25))
+* update documentation URL in pyproject.toml ([#66](https://github.com/Fundamental-Technologies/fundamental-client/issues/66)) ([1d21409](https://github.com/Fundamental-Technologies/fundamental-client/commit/1d214095abdb61a47abaecde66e5cee9a69a7ba3))
+
 ## [0.2.3](https://github.com/Fundamental-Technologies/fundamental-client/compare/0.2.2...0.2.3) (2026-02-03)
 
 

fundamental_client-0.2.4/CONTRIBUTING.md

@@ -0,0 +1,153 @@
+# Contributing to Fundamental Python SDK
+
+We welcome contributions to the Fundamental Python SDK! Whether it's a bug fix, documentation improvement, or additional tests, your help is appreciated.
+
+## Reporting Issues
+
+Go to this repository's [issues page](https://github.com/fundamental/fundamental-python/issues) and click "New Issue". Please check if the issue has already been reported before creating a new one.
+
+Include the following information:
+
+- Describe what you expected to happen
+- If possible, include a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
+- Describe what actually happened, including the full traceback if there was an exception
+- List your Python version and SDK version
+
+## Development Setup
+
+Fork the repository and clone it locally:
+
+```bash
+git clone https://github.com/YOUR-USERNAME/fundamental-python
+cd fundamental-python
+git checkout -b my-feature-branch main
+```
+
+### Quick Setup
+
+We recommend using our bootstrap script for easy setup:
+
+```bash
+./scripts/bootstrap
+```
+
+### Manual Installation
+
+```bash
+# Install with development dependencies using UV
+uv sync --group dev
+
+# Or with pip
+pip install -e ".[dev]"
+```
+
+## Making Changes
+
+1. Make your changes
+2. Format code: `./scripts/format`
+3. Check linting: `./scripts/lint`
+4. Run tests: `./scripts/test`
+
+## Testing
+
+We use [pytest](https://docs.pytest.org/) for testing. To run tests:
+
+```bash
+# Run all tests using the test script
+./scripts/test
+
+# Or run directly with nox for all Python versions
+uv run nox -s tests
+
+# Run tests for specific Python version
+uv run nox -s tests-3.10
+
+# Run tests with minimum dependencies
+uv run nox -s tests-3.10 -- minimum
+
+# Run specific test file directly
+uv run pytest tests/unit/test_estimators.py -v
+```
+
+When adding new tests, place them in the `tests/` directory following the same structure as the source code.
+
+## Code Quality
+
+```bash
+# Format code using the format script
+./scripts/format
+
+# Run all linting checks using the lint script
+./scripts/lint
+
+# Or run individual checks:
+# Ruff check
+uv run ruff check .
+
+# Type checking with pyright
+uv run pyright
+
+# Type checking with mypy
+uv run mypy .
+
+# Run all pre-commit hooks
+uv run pre-commit run --all-files
+```
+
+## Generating API Models
+
+The SDK uses auto-generated Pydantic models from the Fundamental API's OpenAPI specification. This ensures type safety and keeps the client in sync with the API.
+
+```bash
+# Regenerate models from the OpenAPI spec
+./scripts/generate-models
+
+# Use a different OpenAPI URL (e.g., production)
+OPENAPI_URL=https://api.fundamental-dev.tech/openapi.json ./scripts/generate-models
+```
+
+Generated models are placed in `src/fundamental/models/generated.py` and can be imported from `fundamental.models`:
+
+```python
+from fundamental.models import (
+    FitRequest,
+    FitResponse,
+    TaskStatus,
+    TaskStatusResponse,
+)
+```
+
+When the API changes, simply re-run the generation script to update the models.
+
+## Versioning and Release Flow
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. We use [Release Please](https://github.com/googleapis/release-please) for automated versioning and changelog generation.
+
+**Main Branch (Stable Releases):**
+1. Push to `main` triggers Release Please to create/update a Release PR
+2. Merging the Release PR creates a GitHub Release
+3. The GitHub Release triggers publishing to CodeArtifact and TestPyPI
+
+**Feature Branches (Dev Releases):**
+1. Push to any non-main branch publishes a dev version to CodeArtifact
+2. Dev version format: `X.Y.Z.dev0+<commit-hash>`
+
+> **Note:** CodeArtifact may show dev versions as "Latest", but `pip install fundamental-client` will install the stable version. Use `--pre` to install dev versions.
+
+## Opening a Pull Request
+
+Push your branch and open a pull request against the `main` branch. Include:
+
+- Clear title following Conventional Commits format
+- Description of what you changed and why
+- Reference any related issues
+
+Make sure all CI checks pass before requesting review.
+
+## Getting Help
+
+- **Issues**: [GitHub Issues](https://github.com/fundamental/fundamental-python/issues) for bugs and feature requests
+- **Email**: support@fundamental.tech for questions
+- **Documentation**: See README.md for usage examples
+
+We appreciate all contributions and will provide constructive feedback on pull requests. Thank you for helping improve the Fundamental Python SDK!

{fundamental_client-0.2.3 → fundamental_client-0.2.4}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: fundamental-client
-Version: 0.2.3
+Version: 0.2.4
 Summary: Scikit-learn–compatible client SDK for NEXUS, Fundamental's large model for tabular data
-Project-URL: documentation, https://fundamental.tech/docs
+Project-URL: documentation, https://launch.fundamental.tech/docs/guides/sdk/user-guide
 Author-email: Fundamental Tech <support@fundamental.tech>
 License:                                  Apache License
                                    Version 2.0, January 2004

{fundamental_client-0.2.3 → fundamental_client-0.2.4}/README.md

@@ -27,19 +27,10 @@ A scikit-learn compatible Python SDK for NEXUS, Fundamental's large model for ta
 - [Handling Errors](#handling-errors)
   - [Diagnostics and Support Information](#diagnostics-and-support-information)
   - [Exception Types](#exception-types)
-- [Development](#development)
-  - [Installation](#installation-1)
-  - [Running Tests](#running-tests)
-  - [Code Quality](#code-quality)
-  - [Generating API Models](#generating-api-models)
 - [Versioning](#versioning)
-  - [Release Flow](#release-flow)
-  - [Determining the Installed Version](#determining-the-installed-version)
 - [Requirements](#requirements)
-- [Contributing](#contributing)
 - [License](#license)
 - [Support](#support)
-- [Acknowledgments](#acknowledgments)
 
 ## Installation
 
@@ -374,107 +365,11 @@ except ServerError as e:
 | `RequestTimeoutError` | Request timed out | 504 |
 
 
-## Development
-
-### Installation
-
-```bash
-# Clone the repository
-git clone https://github.com/fundamental/fundamental-python.git
-cd fundamental-python
-
-# Install with development dependencies using UV
-uv sync --group dev
-
-# Or with pip
-pip install -e ".[dev]"
-```
-
-### Running Tests
-
-```bash
-# Run all tests using the test script
-./scripts/test
-
-# Or run directly with nox for all Python versions
-uv run nox -s tests
-
-# Run tests for specific Python version
-uv run nox -s tests-3.10
-
-# Run tests with minimum dependencies
-uv run nox -s tests-3.10 -- minimum
-
-# Run specific test file directly
-uv run pytest tests/unit/test_estimators.py
-```
-
-### Code Quality
-
-```bash
-# Format code using the format script
-./scripts/format
-
-# Run all linting checks using the lint script
-./scripts/lint
-
-# Or run individual checks:
-# Ruff check
-uv run ruff check .
-
-# Type checking with pyright
-uv run pyright
-
-# Type checking with mypy
-uv run mypy .
-
-# Run all pre-commit hooks
-uv run pre-commit run --all-files
-```
-
-### Generating API Models
-
-The SDK uses auto-generated Pydantic models from the Fundamental API's OpenAPI specification. This ensures type safety and keeps the client in sync with the API.
-
-```bash
-# Regenerate models from the OpenAPI spec
-./scripts/generate-models
-
-# Use a different OpenAPI URL (e.g., production)
-OPENAPI_URL=https://api.fundamental-dev.tech/openapi.json ./scripts/generate-models
-```
-
-Generated models are placed in `src/fundamental/models/generated.py` and can be imported from `fundamental.models`:
-
-```python
-from fundamental.models import (
-    FitRequest,
-    FitResponse,
-    TaskStatus,
-    TaskStatusResponse,
-)
-```
-
-When the API changes, simply re-run the generation script to update the models.
-
 ## Versioning
 
-This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. We use [Release Please](https://github.com/googleapis/release-please) for automated versioning and changelog generation.
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions.
 
-### Release Flow
-
-**Main Branch (Stable Releases):**
-1. Push to `main` triggers Release Please to create/update a Release PR
-2. Merging the Release PR creates a GitHub Release
-3. The GitHub Release triggers publishing to CodeArtifact and TestPyPI
-
-**Feature Branches (Dev Releases):**
-1. Push to any non-main branch publishes a dev version to CodeArtifact
-2. Dev version format: `X.Y.Z.dev0+<commit-hash>`
-
-> **Note:** CodeArtifact may show dev versions as "Latest", but `pip install fundamental-client` will install the stable version. Use `--pre` to install dev versions.
-
-### Determining the Installed Version
+To check the installed version:
 
 ```python
 import fundamental
@@ -486,15 +381,6 @@ print(fundamental.__version__)
 - Python 3.10 or higher
 - See [pyproject.toml](pyproject.toml) for full dependency list
 
-## Contributing
-
-We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started.
-
-For quick setup, run:
-```bash
-./scripts/bootstrap
-```
-
 ## License
 
 This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
@@ -502,9 +388,4 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENS
 ## Support
 
 - **Documentation**: [fundamental.tech/docs](https://fundamental.tech/docs)
-- **Issues**: [GitHub Issues](https://github.com/fundamental/fundamental-python/issues)
 - **Email**: [support@fundamental.tech](mailto:support@fundamental.tech)
-
-## Acknowledgments
-
-Built with ❤️ by Fundamental Tech

{fundamental_client-0.2.3 → fundamental_client-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fundamental-client"
-version = "0.2.3"
+version = "0.2.4"
 description = "Scikit-learn–compatible client SDK for NEXUS, Fundamental's large model for tabular data"
 authors = [{name = "Fundamental Tech", email = "support@fundamental.tech"}]
 license = {file = "LICENSE"}
@@ -51,7 +51,7 @@ dev = [
 ]
 
 [project.urls]
-documentation = "https://fundamental.tech/docs"
+documentation = "https://launch.fundamental.tech/docs/guides/sdk/user-guide"
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/fundamental"]

{fundamental_client-0.2.3 → fundamental_client-0.2.4}/uv.lock

@@ -398,7 +398,7 @@ wheels = [
 
 [[package]]
 name = "fundamental-client"
-version = "0.2.2"
+version = "0.2.3"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },

fundamental_client-0.2.3/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "0.2.3"
-}

fundamental_client-0.2.3/CONTRIBUTING.md

@@ -1,74 +0,0 @@
-# Contributing to Fundamental Python SDK
-
-We welcome contributions to the Fundamental Python SDK! Whether it's a bug fix, documentation improvement, or additional tests, your help is appreciated.
-
-## Reporting Issues
-
-Go to this repository's [issues page](https://github.com/fundamental/fundamental-python/issues) and click "New Issue". Please check if the issue has already been reported before creating a new one.
-
-Include the following information:
-
-- Describe what you expected to happen
-- If possible, include a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
-- Describe what actually happened, including the full traceback if there was an exception
-- List your Python version and SDK version
-
-## Development Setup
-
-Fork the repository and clone it locally:
-
-```bash
-git clone https://github.com/YOUR-USERNAME/fundamental-python
-cd fundamental-python
-git checkout -b my-feature-branch main
-```
-
-### Quick Setup
-
-We recommend using our bootstrap script for easy setup:
-
-```bash
-./scripts/bootstrap
-```
-
-## Making Changes
-
-1. Make your changes
-2. Format code: `./scripts/format`
-3. Check linting: `./scripts/lint`
-4. Run tests: `./scripts/test`
-
-## Testing
-
-We use [pytest](https://docs.pytest.org/) for testing. To run tests:
-
-```bash
-# Run all tests
-uv run nox
-
-# Run specific test file
-uv run pytest tests/unit/test_estimators.py -v
-
-# Run tests for specific Python version
-uv run nox -s tests-3.10
-```
-
-When adding new tests, place them in the `tests/` directory following the same structure as the source code.
-
-## Opening a Pull Request
-
-Push your branch and open a pull request against the `main` branch. Include:
-
-- Clear title following Conventional Commits format
-- Description of what you changed and why
-- Reference any related issues
-
-Make sure all CI checks pass before requesting review.
-
-## Getting Help
-
-- **Issues**: For bugs and feature requests
-- **Email**: support@fundamental.tech for questions
-- **Documentation**: See README.md for usage examples
-
-We appreciate all contributions and will provide constructive feedback on pull requests. Thank you for helping improve the Fundamental Python SDK!