aspy21 0.1.1b8__tar.gz

aspy21-0.1.1b8/.env.example

@@ -0,0 +1,28 @@
+# Aspen IP.21 Configuration
+# Copy this file to .env and fill in your actual values
+
+# Server URL (full path to AtProcessDataREST.dll)
+ASPEN_BASE_URL=http://YOUR_SERVER/ProcessData/AtProcessDataREST.dll
+
+# Basic Authentication
+ASPEN_USERNAME=yourusername
+ASPEN_PASSWORD=yourpassword
+
+# Datasource name (leave empty for server default)
+ASPEN_DATASOURCE=datasource_name
+
+# Optional settings
+ASPEN_TIMEOUT=60.0
+ASPEN_VERIFY_SSL=False
+
+# Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+ASPEN_LOG_LEVEL=INFO
+
+# PyPI Publishing (for maintainers only)
+# Get tokens from:
+# - TestPyPI: https://test.pypi.org/manage/account/token/
+# - PyPI: https://pypi.org/manage/account/token/
+PYPI_TEST_USERNAME=__token__
+PYPI_TEST_TOKEN=your-testpypi-token-here
+PYPI_USERNAME=__token__
+PYPI_TOKEN=your-pypi-token-here

aspy21-0.1.1b8/.github/SETUP_GUIDE.md

@@ -0,0 +1,123 @@
+# Development Setup Guide
+
+This guide will help you set up your development environment for the aspy21 project.
+
+## Prerequisites
+
+- Python 3.9+ installed
+- [uv](https://github.com/astral-sh/uv) package manager
+- [just](https://just.systems/) task runner (optional but recommended)
+
+## Quick Start
+
+### 1. Install uv (if not already installed)
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+### 2. Install dependencies
+
+```bash
+uv pip install -e ".[dev]"
+```
+
+### 3. Setup pre-commit hooks
+
+```bash
+pre-commit install
+```
+
+## Available Commands
+
+If you have `just` installed, you can use these convenient commands:
+
+```bash
+just install          # Install dependencies
+just setup-hooks      # Setup pre-commit hooks
+just test             # Run tests with coverage
+just lint             # Run linter
+just lint-fix         # Auto-fix linting issues
+just format           # Format code
+just typecheck        # Run type checking
+just check            # Run all checks (lint, format, typecheck)
+just ci               # Run all checks + tests (same as CI)
+just clean            # Clean build artifacts
+just build            # Build distribution packages
+```
+
+Or use the tools directly:
+
+```bash
+# Testing
+pytest
+pytest -vv  # verbose
+pytest tests/test_client.py  # specific file
+
+# Linting & Formatting
+ruff check .
+ruff check --fix .
+ruff format .
+
+# Type Checking
+pyright
+
+# Pre-commit (run all hooks)
+pre-commit run --all-files
+```
+
+## Project Structure
+
+```
+aspy21/
+├── src/aspy21/          # Main package code
+│   ├── __init__.py
+│   ├── client.py        # AspenClient implementation
+│   ├── models.py        # Data models (ReaderType, etc.)
+│   ├── utils.py         # Utility functions
+│   └── cache.py         # Caching implementation
+├── tests/               # Test suite
+├── .github/workflows/   # CI/CD pipelines
+├── docs/                # Documentation
+├── pyproject.toml       # Project configuration
+├── justfile             # Task automation
+└── .pre-commit-config.yaml  # Pre-commit hooks
+
+```
+
+## Modern Toolchain (2025)
+
+This project uses the latest Python tooling:
+
+- **Package Manager**: `uv` (10-100x faster than pip)
+- **Linter + Formatter**: `ruff` (replaces black, flake8, isort)
+- **Type Checker**: `pyright` (fast, actively maintained)
+- **Test Runner**: `pytest` with coverage
+- **Task Runner**: `just` (optional, for convenience)
+- **Pre-commit**: Automated code quality checks
+
+## CI/CD
+
+GitHub Actions automatically:
+- Tests on Python 3.9, 3.10, 3.11, 3.12, 3.13
+- Runs linting, formatting, and type checking
+- Reports test coverage to Codecov
+- Publishes to PyPI on version tags
+
+## Publishing to PyPI
+
+1. Update version in `pyproject.toml`
+2. Update `CHANGELOG.md`
+3. Create and push a git tag:
+   ```bash
+   git tag v0.1.0
+   git push origin v0.1.0
+   ```
+4. GitHub Actions will automatically build and publish to PyPI
+
+## Tips
+
+- Always run `just check` before committing
+- Pre-commit hooks will catch issues automatically
+- Use `just ci` to run the same checks as GitHub Actions locally
+- Keep CHANGELOG.md updated with each change

aspy21-0.1.1b8/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Release to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # for trusted publishing
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build distribution
+        run: |
+          uv pip install --system build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true

aspy21-0.1.1b8/.github/workflows/tests.yml

@@ -0,0 +1,47 @@
+name: Tests & Lint
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          uv pip install --system -e ".[dev]"
+
+      - name: Ruff lint
+        run: ruff check .
+
+      - name: Ruff format check
+        run: ruff format --check .
+
+      - name: Type check (pyright)
+        run: pyright
+
+      - name: Run tests
+        run: pytest --cov=aspy21 --cov-report=xml --cov-report=term
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.11'
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false

aspy21-0.1.1b8/.gitignore

@@ -0,0 +1,47 @@
+# Python
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+*.egg-info/
+.build/
+dist/
+build/
+.coverage
+htmlcov/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.tox/
+.Python
+*.egg
+*.whl
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Environment files (may contain secrets)
+.env
+.env.*
+!.env.example
+
+# IDE
+.vscode/
+.idea/
+
+# Jupyter Notebooks
+.ipynb_checkpoints/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Development context (contains session-specific info)
+CLAUDE.md
+WORKFLOW.md
+
+# Auto-generated version file
+src/aspy21/_version.py

aspy21-0.1.1b8/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-toml
+
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.389
+    hooks:
+      - id: pyright
+        additional_dependencies:
+          - httpx>=0.27
+          - pandas>=2.0
+          - pydantic>=2.6
+          - python-dateutil>=2.9
+          - tenacity>=9.0
+          - python-dotenv>=1.0
+          - pytest>=8.2
+          - respx>=0.21

aspy21-0.1.1b8/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial project structure
+- AspenClient with REST API support
+- Support for analog, discrete, and text tags
+- Unified pandas DataFrame output
+- Built-in caching with SQLite
+- Automatic retry logic with tenacity
+- Type annotations and type checking
+- Comprehensive test suite
+- GitHub Actions CI/CD pipeline
+- MIT License
+
+## [0.1.0] - 2025-10-29
+
+### Added
+- Initial release
+- REST-only backend for Aspen InfoPlus.21
+- Support for RAW, INT, SNAPSHOT, AVG reader types
+- DataFrame output with optional status column
+- Transparent batching and connection management
+- 100% type-annotated code
+
+[Unreleased]: https://github.com/bazdalaz/aspy21/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/bazdalaz/aspy21/releases/tag/v0.1.0

aspy21-0.1.1b8/CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+# Code of Conduct
+
+We follow the [Contributor Covenant](https://www.contributor-covenant.org/) Code of Conduct.
+
+## Our Pledge
+Be respectful, inclusive, and constructive.
+
+## Our Standards
+- Use welcoming language
+- Be considerate of differing viewpoints
+- Gracefully accept constructive criticism
+- Focus on what is best for the community
+
+## Enforcement
+Report issues to the maintainers at **bazdalaz@gmail.com**.

aspy21-0.1.1b8/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing to aspy21
+
+Thanks for helping! Please follow this checklist.
+
+## Setup
+
+```bash
+git clone https://github.com/bazdalaz/aspy21.git
+cd aspy21
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"

aspy21-0.1.1b8/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 bazdalaz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.