soildb 0.1.0__tar.gz

soildb-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,173 @@
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+  release:
+    types: [ published ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    
+    steps:
+    - uses: actions/checkout@v5
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Cache pip dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt', '**/pyproject.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[all]"
+
+    - name: Lint with ruff
+      run: |
+        ruff check src/ tests/ examples/ --output-format=github
+      continue-on-error: true
+      
+    - name: Type check with mypy
+      run: |
+        mypy src/soildb --ignore-missing-imports
+      continue-on-error: true
+    
+    - name: Test with pytest
+      run: |
+        pytest tests/ -v --cov=soildb --cov-report=xml --cov-report=term-missing
+    
+    - name: Upload coverage to Codecov
+      if: matrix.python-version == '3.11'
+      uses: codecov/codecov-action@v5
+      with:
+        file: ./coverage.xml
+        fail_ci_if_error: false
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ruff mypy
+    
+    - name: Lint with ruff
+      run: |
+        ruff check src/ tests/ examples/ --output-format=github
+      continue-on-error: true
+    
+    - name: Type check with mypy
+      run: |
+        mypy src/soildb --ignore-missing-imports
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install bandit safety
+    
+    - name: Run security checks with bandit
+      run: |
+        bandit -r src/ -f json -o bandit-report.json
+      continue-on-error: true
+
+    - name: Check dependencies with safety
+      run: |
+        safety check --json --output safety-report.json
+      continue-on-error: true
+    
+    - name: Upload security artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: security-reports
+        path: |
+          bandit-report.json
+          safety-report.json
+
+  examples:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+    
+    - name: Test basic examples (no network)
+      run: |
+        python -c "
+        import sys
+        sys.path.insert(0, 'examples')
+        
+        # Test imports and basic functionality
+        try:
+            import soildb
+            print('Package imports successfully')
+            
+            query = soildb.get_mapunit_by_areasymbol('IA169')
+            print('Basic query construction works')
+            
+            print('All basic functionality tests passed')
+        except Exception as e:
+            print(f'Basic functionality test failed: {e}')
+            sys.exit(1)
+        "
+
+  integration:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [test, lint]
+    steps:
+    - uses: actions/checkout@v5
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[all]"
+    
+    - name: Run integration tests (with network)
+      run: |
+        pytest tests/test_integration.py -v -m "not slow" --timeout=30
+      env:
+        PYTHONPATH: ${{ github.workspace }}/src

soildb-0.1.0/.github/workflows/pypi-release.yml

@@ -0,0 +1,36 @@
+name: Upload Python Package to PyPI
+
+on:
+  workflow_dispatch:
+  release:
+    types: [created]
+
+jobs:
+  pypi-publish:
+    name: Publish release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/py-soildb
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install and verify Hatch
+        run: |
+          sudo apt install pipx
+          pipx install hatch
+          hatch --version
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+      - name: Build package
+        run: |
+          hatch build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

soildb-0.1.0/.gitignore

@@ -0,0 +1,178 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+.ruff_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For PyCharm
+#  Community Edition, use 'PyCharm CE' instead of 'PyCharm'.
+.idea/
+
+# VS Code
+.vscode/
+
+# macOS
+.DS_Store
+
+# Test data
+test_data/
+*.csv
+*.parquet
+
+# scratch files
+scratch/
+examples_p/
+
+# agent instructions
+copilot-instructions.md

soildb-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.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/astral-sh/ruff-pre-commit
+    rev: v0.1.0
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.5.1
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-all]
+        args: [--ignore-missing-imports]
+
+  - repo: local
+    hooks:
+      - id: quarto-readme
+        name: Render README
+        entry: quarto render docs/index.qmd --to gfm --output README.md && mv docs/README.md ../README.md
+        language: system
+        files: ^docs/index.qmd$
+        stages: [pre-commit]

soildb-0.1.0/.readthedocs.yaml

@@ -0,0 +1,21 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+  jobs:
+    post_install:
+      - pip install -r requirements-dev.txt
+      - pip install -e . 
+      - curl -LO https://github.com/quarto-dev/quarto-cli/releases/download/v1.4.553/quarto-1.4.553-linux-amd64.deb
+      - apt-get update && apt-get install -y ./quarto-1.4.553-linux-amd64.deb
+      - quartodoc build --config docs/_quarto.yml
+      - quarto render docs/
+formats: []
+sphinx:
+  configuration: null
+mkdocs:
+  configuration: null
+output:
+  html: docs/_site

soildb-0.1.0/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## [0.1.0] - 2025-09-28
+
+Initial release of soildb Python package.
+
+### Added
+- SDA client for querying USDA soil data
+- Query builder for custom SQL queries
+- DataFrame export (pandas and polars)
+- Spatial queries with bounding boxes and points
+- Bulk data fetching with pagination
+- Example scripts for soil analysis

soildb-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,135 @@
+# Contributing
+
+Guidelines for contributing to soildb.
+
+## Development Setup
+
+1. Fork the repository and clone your fork:
+   ```bash
+   git clone https://github.com/your-username/py-soildb.git
+   cd py-soildb
+   ```
+
+2. Create a virtual environment:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. Install the package in development mode:
+   ```bash
+   pip install -e ".[dev,dataframes,spatial]"
+   ```
+
+4. Install pre-commit hooks:
+   ```bash
+   pre-commit install
+   ```
+
+## Running Tests
+
+Run the test suite:
+```bash
+pytest
+```
+
+Run tests with coverage:
+```bash
+pytest --cov=soildb --cov-report=html
+```
+
+Run only unit tests (skip integration tests):
+```bash
+pytest -m "not integration"
+```
+
+## Code Style
+
+We use several tools to maintain code quality:
+
+- **ruff** for code formatting and linting (combines Black, flake8, and more)
+- **mypy** for type checking
+
+Run all checks:
+```bash
+ruff check src/ tests/ examples/
+ruff format src/ tests/ examples/
+mypy src/
+```
+
+Or use the Makefile shortcuts:
+```bash
+make lint    # Run ruff check and mypy
+make format  # Format code with ruff
+```
+
+## Making Changes
+
+1. Create a new branch for your feature or bug fix:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. Make your changes and write tests to cover them.
+
+3. Ensure all tests pass and code style checks pass.
+
+4. Commit your changes with a clear commit message:
+   ```bash
+   git commit -m "Add feature: description of your changes"
+   ```
+
+5. Push your changes and create a pull request.
+
+## Pull Request Guidelines
+
+- Include a clear description of the changes
+- Reference any related issues
+- Ensure all tests pass
+- Include tests for new functionality
+- Update documentation as needed
+- Follow the existing code style
+
+## Reporting Issues
+
+When reporting issues, please include:
+
+- Python version
+- soildb version
+- Operating system
+- Complete error traceback
+- Minimal code example that reproduces the issue
+
+## Integration Tests
+
+Some tests require network access to query the actual SDA service. These are marked with `@pytest.mark.integration` and are skipped by default.
+
+To run integration tests:
+```bash
+pytest -m integration
+```
+
+**Note:** Integration tests may fail if the SDA service is under maintenance.
+
+## Documentation
+
+Documentation is built using Sphinx. To build documentation locally:
+
+```bash
+cd docs/
+make html
+```
+
+The built documentation will be in `docs/_build/html/`.
+
+## Release Process
+
+1. Update version in `pyproject.toml` and `src/soildb/__init__.py`
+2. Update `CHANGELOG.md`
+3. Create a git tag: `git tag v0.x.x`
+4. Push tag: `git push origin v0.x.x`
+5. GitHub Actions will automatically build and publish to PyPI
+
+## License
+
+By contributing to soildb, you agree that your contributions will be licensed under the MIT License.

soildb-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Andrew Brown
+
+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.

soildb-0.1.0/Makefile

@@ -0,0 +1,69 @@
+.PHONY: help install test lint format docs clean build
+.DEFAULT_GOAL := help
+
+help: ## Show this help message
+	@echo "Available commands:"
+	@awk 'BEGIN {FS = ":.*##"} /^[a-zA-Z_-]+:.*?##/ { printf "  %-15s %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
+
+install: ## Install the package in development mode
+	pip install -e ".[dev,dataframes,spatial,docs,security]"
+
+install-prod: ## Install only production dependencies
+	pip install -e .
+
+test: ## Run the test suite
+	pytest tests/ -v
+
+test-cov: ## Run tests with coverage
+	pytest tests/ -v --cov=soildb --cov-report=html --cov-report=term-missing
+
+test-integration: ## Run integration tests (requires network)
+	pytest tests/test_integration.py -v
+
+lint: ## Run linting checks
+	ruff check src/ tests/ examples/
+	mypy src/soildb --ignore-missing-imports
+
+format: ## Format code
+	ruff format src/ tests/ examples/
+
+format-check: ## Check code formatting without making changes
+	ruff format --check src/ tests/ examples/
+
+security: ## Run security checks
+	bandit -r src/
+	safety check
+
+docs: ## Build documentation with Quarto
+	quartodoc build --config docs/_quarto.yml
+	quarto render docs
+
+docs-serve: ## Serve documentation with Quarto and watch for changes
+	quartodoc build --config docs/_quarto.yml
+	quarto preview docs
+
+clean: ## Clean build artifacts
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info/
+	rm -rf .coverage
+	rm -rf htmlcov/
+	rm -rf .pytest_cache/
+	rm -rf .mypy_cache/
+	find . -type d -name __pycache__ -exec rm -rf {} +
+	find . -type f -name "*.pyc" -delete
+
+build: ## Build the package
+	python -m build
+
+pre-commit-install: ## Install pre-commit hooks
+	pre-commit install
+
+pre-commit-run: ## Run pre-commit on all files
+	pre-commit run --all-files
+
+examples: ## Run example scripts (basic functionality test)
+	@echo "Testing basic examples..."
+	@python -c "import soildb; print('✓ Package imports successfully')"
+	@python examples/basic_examples.py
+	@echo "✓ All examples completed successfully"