sweetconnect-api 0.1.1.dev312

A SweetConnect API library for Python

SweetConnect API Library

Features

• TODO

Requirements

• TODO

Installation

You can install SweetConnect API Library via pip from PyPI:

$ pip install sweetconnect-api

Development

This project uses uv for dependency management. To set up a development environment:

# Install uv (if not already installed)
$ curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone the repository
$ git clone https://gitlab.com/sweetconnect/public/sweetconnect-api
$ cd sweetconnect-api

# Install dependencies
$ uv sync

# Run tests
$ uv run pytest

# Run all checks with nox
$ uv tool run nox

# Run linting with ruff
$ uv run ruff check .
$ uv run ruff format .

Code Quality Notes

Linting: This project uses Ruff for linting and formatting.

Pre-commit Hooks: This project uses pre-commit hooks to ensure code quality before commits.

To set up pre-commit hooks:

# Install pre-commit hooks (one-time setup)
$ uv run pre-commit install

# Run hooks manually on all files
$ uv run pre-commit run --all-files

# Run hooks on staged files only (happens automatically on commit)
$ git commit

The pre-commit hooks will automatically check:

• Ruff: Code linting and formatting
• File checks: Large files, TOML/YAML syntax, trailing whitespace
• Secret detection: Prevents committing passwords, API keys, and private keys
• Prettier: Formats JSON/YAML/Markdown files

Known Issues to Address:

• API models use mixedCase naming (e.g., assetId, tenantId) following the REST API convention
• Some examples use star imports (from module import *)
• A few bare except clauses need specific exception handling
• Missing docstrings in some public APIs

These naming conventions are intentional to match the SweetConnect API design and will be preserved. Other issues will be addressed in future updates.

Versioning

This project uses hatch-vcs for automatic version management based on Git tags:

• Release versions (e.g., 0.1.0): Created from Git tags (e.g., v0.1.0)
• Development versions (e.g., 0.1.1.dev0+g5712c2b): Automatically generated between releases

To create a new release:

# Create and push a version tag
$ git tag v0.2.0
$ git push origin v0.2.0

The version is automatically determined from Git history - no manual version updates needed in pyproject.toml.

Continuous Integration

This project uses Bitbucket Pipelines for CI/CD. The pipeline runs:

• Linting: Ruff checks code style and quality
• Type Checking: mypy is currently disabled due to too many type errors that need to be addressed
• Security: Safety checks are currently disabled
• Build: Creates distribution packages
• Deployments:
  • dev: Automatically deploys to PyPI from the main branch (development versions)
  • production: Automatically deploys to PyPI when a v* tag is pushed (release versions)

Setup Requirements:

To enable PyPI publishing, add the PYPI_TOKEN secret in Bitbucket:

1. Go to Repository Settings → Pipelines → Repository variables
2. Add variable: PYPI_TOKEN with your PyPI API token

Usage

Please see the Command-line Reference for details. The documentation for the api-endpoints is available here:

• prod: https://doc.api.my.sweetconnect.io/
• test: https://doc.api.test.sweetconnect.io/
• dev: https://doc.api.dev.sweetconnect.io/

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template. For more details see Hypermodern Python documentation

License

Distributed under the terms of the GPL 3.0 license, SweetConnect API Library is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.