baresquare-sdk 0.1.0__tar.gz

baresquare_sdk-0.1.0/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# These owners will be the default owners for everything
+# in the repo, unless a later match takes precedence
+*                       @lucas-bsq

baresquare_sdk-0.1.0/.github/pr-prefix-labeler.yml

@@ -0,0 +1,11 @@
+"[feat]": "feat"
+"[fix]": "fix"
+"[docs]": "docs"
+"[style]": "style"
+"[refactor]": "refactor"
+"[perf]": "perf"
+"[test]": "test"
+"[build]": "build"
+"[ci]": "ci"
+"[chore]": "chore"
+"[revert]": "revert"

baresquare_sdk-0.1.0/.github/release.yml

@@ -0,0 +1,14 @@
+changelog:
+  categories:
+    - title: Features
+      labels:
+        - feat
+    - title: Fixes
+      labels:
+        - fix
+    - title: Documentation
+      labels:
+        - docs
+    - title: Other
+      labels:
+        - '*'

baresquare_sdk-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,44 @@
+name: Build and Publish Python Packages to PyPI
+
+on:
+  # Publish when tags are pushed
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build-and-publish:
+    name: Build and Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build and publish core package
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          cd core
+          python -m build
+          python -m twine upload dist/*
+
+      - name: Build and publish AWS package
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          cd aws
+          python -m build
+          python -m twine upload dist/*

baresquare_sdk-0.1.0/.github/workflows/pull-request-checks.yml

@@ -0,0 +1,45 @@
+name: "Semantic Pull Request and automatic labeling"
+
+on:
+  pull_request:
+    types: [opened, edited, reopened]
+
+jobs:
+  main:
+    name: Validate PR title and label the PR
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Validate PR title
+        uses: BareSquare/action-semantic-pull-request@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # https://github.com/commitizen/conventional-commit-types/blob/master/index.json
+          types: |
+            [feat]
+            [fix]
+            [docs]
+            [style]
+            [refactor]
+            [perf]
+            [test]
+            [build]
+            [ci]
+            [chore]
+            [revert]
+          scopes: |
+            PL-\d+
+            ADHOC
+          requireScope: true
+          subjectPattern: ^[A-Z].*$
+          subjectPatternError: |
+            The subject "{subject}" found in the pull request title "{title}"
+            didn't match the configured pattern. Please ensure that the subject
+            starts with an uppercase character.
+          headerPattern: '^(\[\w*\]) (?:([\w\$\.\-\* ]*))?\: (.*)$'
+          headerPatternCorrespondence: type, scope, subject
+
+      - name: Label the PR
+        uses: BareSquare/pr-prefix-labeler@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

baresquare_sdk-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on:
+  # Run tests on pull requests
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test-and-lint:
+    name: Feature branch tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: '.python-version'
+
+      - name: Install package in editable mode with dev dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[linting,testing,aws]"
+
+      - name: Run linting
+        run: |
+          ruff format --check src tests
+          ruff check src tests
+
+      - name: Run tests
+        run: |
+          pytest

baresquare_sdk-0.1.0/.gitignore

@@ -0,0 +1,44 @@
+# Editors
+.vscode/
+.idea/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+wheel_extract
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+coverage.xml
+*.cover
+.pytest_cache/
+
+# Virtual environments
+venv/
+env/
+ENV/
+.env/
+.venv/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# mypy
+.mypy_cache/
+
+# ruff
+.ruff_cache/
+
+# Logs
+*.log

baresquare_sdk-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

baresquare_sdk-0.1.0/LICENSE

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

baresquare_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: baresquare-sdk
+Version: 0.1.0
+Summary: Baresquare SDK for Python
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: fastapi>=0.115.12
+Provides-Extra: aws
+Requires-Dist: boto3>=1.38.21; extra == 'aws'
+Requires-Dist: pyjwt[crypto]==2.10.1; extra == 'aws'
+Requires-Dist: requests==2.32.3; extra == 'aws'
+Provides-Extra: dev
+Requires-Dist: boto3>=1.38.21; extra == 'dev'
+Requires-Dist: pyjwt[crypto]==2.10.1; extra == 'dev'
+Requires-Dist: pytest==8.3.5; extra == 'dev'
+Requires-Dist: requests==2.32.3; extra == 'dev'
+Requires-Dist: ruff==0.11.9; extra == 'dev'
+Provides-Extra: linting
+Requires-Dist: ruff==0.11.9; extra == 'linting'
+Provides-Extra: testing
+Requires-Dist: pytest==8.3.5; extra == 'testing'
+Description-Content-Type: text/markdown
+
+# Baresquare Python Libraries
+
+> [!CAUTION]
+> This code is published publicly in PyPI - make sure you do not include proprietary information.
+
+This monorepo hosts Baresquare's Python packages, all published to PyPI.
+
+## Packages
+
+The repository currently contains the following packages:
+
+- **baresquare_core_py**: Core utilities shared across Baresquare services
+- **baresquare_aws_py**: AWS-specific utilities that build upon core
+
+## Development Guidelines
+
+### Versioning
+
+- All packages share the same version number
+- Version is defined in each package's `__init__.py` file (`__version__ = "x.y.z"`)
+- Git tags must match the version in `__init__.py` files (format: `vx.y.z`)
+- CI will validate version consistency before publishing
+
+### Package Configuration
+
+- A single `pyproject.toml` file is used for all packages
+- Package-specific settings are handled in the CI process
+- Dependencies between packages are defined in `pyproject.toml` under `[project.optional-dependencies]`
+
+### Development Setup
+
+To set up the packages for development:
+
+```shell
+# Install in development mode with all dependencies
+pip install -e ".[testing]"
+
+# Run tests
+pytest
+```
+
+> [!WARNING]  
+> When introducing a new `.py` file, make sure to add it in the appropriate `__init__.py` file, otherwise it will not be
+> makde available in the published package. 
+
+### Linting
+
+For each directory:
+- Show linting issues: `ruff check . --preview`
+- Fix linting issues: `ruff . --fix --preview`
+
+### Testing
+
+Install packages
+
+```shell
+# First in the core directory 
+cd core
+pip install -e .
+
+# Then in the aws directory
+cd ../aws
+pip install -e .[testing]
+```
+
+Then run `pytest` in each directory
+
+## Publishing
+
+> [!TIP]
+> Before publishing properly, check the build locally (see instructions below).
+
+### With GitHub Action
+
+**It is recommended to publish a new version by creating a GitHub release, as this creates release notes in the relevant 
+GitHub page.**
+
+Packages are published to PyPI through GitHub Actions when a new tag is pushed:
+
+1. Update the `version` field in all `pyproject.toml` files (should be the same everywhere)
+1. If there is optional dependency array `publishing`, update the core package version there too (e.g. in `pyproject.toml` of the AWS package)
+1. Commit changes
+1. Create and push a tag matching the version (assuming version to be published is 0.1.0):
+   - via command line: `git tag v0.1.0 && git push origin v0.1.0`
+   - via GitHub UI: Go to "Releases" → "Draft a new release" → "Choose a tag" → Enter "v0.1.0" → "Create new tag"
+
+CI will validate versions, build packages, and publish to PyPI
+
+### Manually
+
+You can also use `scripts/publish_local.sh`:
+
+1. Set environment variables:
+   ```shell
+   export TWINE_USERNAME=__token__
+   export TWINE_PASSWORD=XXX
+   ``` 
+1. If there is optional dependency array `publishing`, update the core package version there too (e.g. in `pyproject.toml` of the AWS package)
+1. Check `pyproject.toml` files of non-core packages - they may reference the version of `baresquare-core-py`
+1. Create a tag locally matching the version
+1. Run `scripts/publish_local.sh`
+
+### Check the build
+
+When introducing a new file, ensure the file will be made available in the published package.
+
+```shell
+cd core
+python -m build
+mkdir -p wheel_extract
+# Extract the wheel (it's just a zip file) - make sure to change the version accordingly
+unzip dist/baresquare_core_py-0.1.0-py3-none-any.whl -d wheel_extract
+# View the contents
+ls -la wheel_extract
+# Specifically check for your Python files
+find wheel_extract -name "*.py"
+```
+
+then check the file exists in the output.
+
+These instructions are for the `core` package - adjust accordingly for other packages.
+
+## Installation
+
+
+```shell
+# Install core package
+pip install baresquare_core_py
+
+# Install AWS package (which includes core)
+pip install baresquare_aws_py
+```
+
+## License
+
+MIT License

baresquare_sdk-0.1.0/README.md

@@ -0,0 +1,136 @@
+# Baresquare Python Libraries
+
+> [!CAUTION]
+> This code is published publicly in PyPI - make sure you do not include proprietary information.
+
+This monorepo hosts Baresquare's Python packages, all published to PyPI.
+
+## Packages
+
+The repository currently contains the following packages:
+
+- **baresquare_core_py**: Core utilities shared across Baresquare services
+- **baresquare_aws_py**: AWS-specific utilities that build upon core
+
+## Development Guidelines
+
+### Versioning
+
+- All packages share the same version number
+- Version is defined in each package's `__init__.py` file (`__version__ = "x.y.z"`)
+- Git tags must match the version in `__init__.py` files (format: `vx.y.z`)
+- CI will validate version consistency before publishing
+
+### Package Configuration
+
+- A single `pyproject.toml` file is used for all packages
+- Package-specific settings are handled in the CI process
+- Dependencies between packages are defined in `pyproject.toml` under `[project.optional-dependencies]`
+
+### Development Setup
+
+To set up the packages for development:
+
+```shell
+# Install in development mode with all dependencies
+pip install -e ".[testing]"
+
+# Run tests
+pytest
+```
+
+> [!WARNING]  
+> When introducing a new `.py` file, make sure to add it in the appropriate `__init__.py` file, otherwise it will not be
+> makde available in the published package. 
+
+### Linting
+
+For each directory:
+- Show linting issues: `ruff check . --preview`
+- Fix linting issues: `ruff . --fix --preview`
+
+### Testing
+
+Install packages
+
+```shell
+# First in the core directory 
+cd core
+pip install -e .
+
+# Then in the aws directory
+cd ../aws
+pip install -e .[testing]
+```
+
+Then run `pytest` in each directory
+
+## Publishing
+
+> [!TIP]
+> Before publishing properly, check the build locally (see instructions below).
+
+### With GitHub Action
+
+**It is recommended to publish a new version by creating a GitHub release, as this creates release notes in the relevant 
+GitHub page.**
+
+Packages are published to PyPI through GitHub Actions when a new tag is pushed:
+
+1. Update the `version` field in all `pyproject.toml` files (should be the same everywhere)
+1. If there is optional dependency array `publishing`, update the core package version there too (e.g. in `pyproject.toml` of the AWS package)
+1. Commit changes
+1. Create and push a tag matching the version (assuming version to be published is 0.1.0):
+   - via command line: `git tag v0.1.0 && git push origin v0.1.0`
+   - via GitHub UI: Go to "Releases" → "Draft a new release" → "Choose a tag" → Enter "v0.1.0" → "Create new tag"
+
+CI will validate versions, build packages, and publish to PyPI
+
+### Manually
+
+You can also use `scripts/publish_local.sh`:
+
+1. Set environment variables:
+   ```shell
+   export TWINE_USERNAME=__token__
+   export TWINE_PASSWORD=XXX
+   ``` 
+1. If there is optional dependency array `publishing`, update the core package version there too (e.g. in `pyproject.toml` of the AWS package)
+1. Check `pyproject.toml` files of non-core packages - they may reference the version of `baresquare-core-py`
+1. Create a tag locally matching the version
+1. Run `scripts/publish_local.sh`
+
+### Check the build
+
+When introducing a new file, ensure the file will be made available in the published package.
+
+```shell
+cd core
+python -m build
+mkdir -p wheel_extract
+# Extract the wheel (it's just a zip file) - make sure to change the version accordingly
+unzip dist/baresquare_core_py-0.1.0-py3-none-any.whl -d wheel_extract
+# View the contents
+ls -la wheel_extract
+# Specifically check for your Python files
+find wheel_extract -name "*.py"
+```
+
+then check the file exists in the output.
+
+These instructions are for the `core` package - adjust accordingly for other packages.
+
+## Installation
+
+
+```shell
+# Install core package
+pip install baresquare_core_py
+
+# Install AWS package (which includes core)
+pip install baresquare_aws_py
+```
+
+## License
+
+MIT License

baresquare_sdk-0.1.0/baresquare_sdk/__init__.py

@@ -0,0 +1,16 @@
+"""Baresquare SDK for Python.
+
+This package provides core utilities and AWS integrations for Baresquare services.
+"""
+
+# Make submodules available for import
+from . import core
+
+# Only import aws if dependencies are available
+try:
+    from . import aws
+except ImportError:
+    # AWS dependencies not installed
+    aws = None
+
+__all__ = ["core", "aws"]

baresquare_sdk-0.1.0/baresquare_sdk/aws/__init__.py

@@ -0,0 +1,21 @@
+"""Baresquare AWS Python utilities.
+
+This package provides AWS-specific utilities for Baresquare services.
+"""
+
+try:
+    # Check if AWS dependencies are available
+    import boto3  # noqa: F401
+
+    from . import authentication
+    from . import s3
+    from . import ssm
+
+    from ..core.logger import setup_logger
+
+    logger = setup_logger()
+
+    __all__ = ["authentication", "s3", "ssm", "logger"]
+
+except ImportError as e:
+    raise ImportError("AWS dependencies not found. Install with: pip install baresquare-sdk[aws]") from e