v0.8.0

Merry Christmas! 🎅 🎄

This release pulls in all the updates and bug fixes since 0.7.0

Closed Issues

• Can commit only once with session per route (otherwise sqlalchemy.exc.InvalidRequestError) (#768) by seapagan

Breaking Changes

• Feat: implement HMAC-SHA256 for API key hashing (#769) by seapagan

New Features

• Update docker to use Python 3.14 and Postgres 18.1. fix resulting issues (#786) by seapagan
• Migrate to prek from pre-commit (#783) by seapagan
• Update for Python 3.14 compatibility and drop support for Python 3.9 (#782) by seapagan
• December update and refresh (#781) by seapagan
• Feat: add manual database session handling with rollback on exception (#770) by seapagan

Bug Fixes

• Fix/deleted user 500 error (#785) by seapagan

Dependency Updates

• Chore(deps): update actions/checkout action to v6 (#784) by renovate[bot]
• Chore(deps): update actions/checkout action to v6 (#778) by renovate[bot]
• Chore(deps): update astral-sh/setup-uv action to v7 (#776) by renovate[bot]
• Chore(deps): update github/codeql-action action to v4 (#775) by renovate[bot]
• Chore(deps): update actions/checkout action to v5 (#771) by renovate[bot]
• Chore(deps): update mkdocs-swagger-ui-tag digest to fad9a89 (#765) by renovate[bot]

Full Changelog | Diff | Patch

v0.7.0

Closed Issues

• Package psycopg2 is not needed (#759) by teschmitt

Breaking Changes

• Breaking - Refactor UserManager.set_ban_status signature. (#760) by seapagan
• Integrate 'sqladmin' as a backend admin panel (#738) by seapagan
• Implement API Keys. (#734) by seapagan

New Features

• CLI: add commands to create the secret and admin keys (#746) by seapagan
• CLI: add a 'seed' command to the 'db' group to populate the User table (#743) by seapagan
• CLI: add a command to batch-populate random test users into the database (#742) by seapagan
• Add user search endpoint with pagination and CLI command for same (#741) by seapagan
• CLI: add command to add or remove admin status for a user (#740) by seapagan
• Add a favicon for when the API is viewed through a web browser (#736) by seapagan
• Allow Admin users to list/edit/delete other users API keys (#735) by seapagan

Security

• Update libraries as required to fix security alerts (#762) by seapagan

Bug Fixes

• Fix crash when running 'db init' from the CLI (#737) by seapagan

Refactoring

• Remove unused psycopg2 library (#763) by seapagan

Documentation

• Replace the mkdocs swagger plugin with my own fork (#747) by seapagan

Dependency Updates

• Bump urllib3 from 2.3.0 to 2.5.0 (#758) by dependabot[bot]
• Bump requests from 2.32.3 to 2.32.4 (#757) by dependabot[bot]
• Bump h11 from 0.14.0 to 0.16.0 (#754) by dependabot[bot]
• Update astral-sh/setup-uv action to v6 (#753) by renovate[bot]
• Bump h11 from 0.14.0 to 0.16.0 (#752) by dependabot[bot]
• Bump jinja2 from 3.1.5 to 3.1.6 (#748) by dependabot[bot]
• Bump jinja2 from 3.1.5 to 3.1.6 (#745) by dependabot[bot]

Full Changelog | Diff | Patch

v0.6.0

Breaking Changes

• Use latest versions of postgresql and python in docker (#728) by seapagan
• Migrate from poetry to uv (#703) by seapagan

New Features

• Migrate from passlib to libpass (#730) by seapagan
• Fix deprecation warning in tests due to httpx (#727) by seapagan
• Use the python logger in the API instead of print statements (#726) by seapagan
• Update 'Ruff' to latest version and fix any linting issues (#713) by seapagan

Testing

• Get test coverage up to 100% by testing the last uncovered blocks (#732) by seapagan

Bug Fixes

• Fix deprecation warning in docs build d/t mkdocs swagger plugin (#731) by seapagan

Documentation

• Clarify docs (#595) by seapagan

Dependency Updates

• Bump the project dependencies across the board (#729) by seapagan
• Bump cryptography from 44.0.0 to 44.0.1 (#725) by dependabot[bot]
• Update dependencies and fix issues caused by new package versions (#722) by seapagan
• Bump python-multipart from 0.0.17 to 0.0.18 (#720) by dependabot[bot]
• Bump jinja2 from 3.1.4 to 3.1.5 (#719) by dependabot[bot]
• Update astral-sh/ruff-action action to v3 (#717) by renovate[bot]
• Update astral-sh/setup-uv action to v5 (#716) by renovate[bot]
• Bump python-multipart from 0.0.17 to 0.0.18 (#715) by dependabot[bot]
• Update postgres Docker tag to v17 (#706) by renovate[bot]
• Bump sqlalchemy from 2.0.32 to 2.0.35 (#679) by dependabot[bot]
• and 65 more dependency updates

Full Changelog | Diff | Patch

v0.5.4

Security Update

• Updates urllib3 to fix a MODERATE severity security issue.

Dependency Updates

• Bump urllib3 from 2.2.1 to 2.2.2 (#576) by dependabot[bot]
• Bump mkdocs-material from 9.5.25 to 9.5.27 (#575) by dependabot[bot]
• Bump email-validator from 2.1.1 to 2.1.2 (#574) by dependabot[bot]
• Bump ruff from 0.4.7 to 0.4.9 (#573) by dependabot[bot]
• Bump pydantic-settings from 2.3.0 to 2.3.3 (#572) by dependabot[bot]
• Bump pydantic from 2.7.3 to 2.7.4 (#571) by dependabot[bot]
• Bump openapi-readme from 0.2.5 to 0.3.0 (#569) by dependabot[bot]
• Bump pytest from 8.2.1 to 8.2.2 (#568) by dependabot[bot]
• Bump faker from 25.4.0 to 25.8.0 (#565) by dependabot[bot]
• Bump pydantic-settings from 2.2.1 to 2.3.0 (#563) by dependabot[bot]
• and 3 more dependency updates

Full Changelog | Diff | Patch

v0.5.3

Closed Issues

• Poetry install broken under Docker (#534) by seapagan

New Features

• Add a Redis server to the docker compose file (#475) by seapagan

Bug Fixes

• Fix Poetry install broken under Docker (#537) by seapagan

Refactoring

• Migrate to rtoml (#523) by seapagan

Dependency Updates

• Bump requests from 2.31.0 to 2.32.2 (#557) by dependabot[bot]
• Bump ruff from 0.4.4 to 0.4.7 (#556) by dependabot[bot]
• Bump mkdocs-git-revision-date-localized-plugin from 1.2.5 to 1.2.6 (#555) by dependabot[bot]
• Bump pymarkdownlnt from 0.9.19 to 0.9.20 (#554) by dependabot[bot]
• Bump pydantic from 2.7.1 to 2.7.2 (#552) by dependabot[bot]
• Bump faker from 25.2.0 to 25.3.0 (#551) by dependabot[bot]
• Bump uvicorn from 0.29.0 to 0.30.0 (#550) by dependabot[bot]
• Bump mkdocs-material from 9.5.23 to 9.5.25 (#549) by dependabot[bot]
• Bump anyio from 4.3.0 to 4.4.0 (#548) by dependabot[bot]
• Bump aiosmtpd from 1.4.5 to 1.4.6 (#543) by dependabot[bot]
• and 59 more dependency updates

Full Changelog | Diff | Patch

v0.5.2

Closed Issues

• Projects generated from template fail tests d/t codacy key (#448) by seapagan
• DB Connection / release error (#331) by seapagan

Merged Pull Requests

• Re-enable codacy coverage reports (#419) by seapagan

Testing

• Update the coverage action (#454) by seapagan

Refactoring

• Ensure docker config explicitly uses port 8001 (#453) by seapagan
• Update formatting to match Ruff 3.0 and remove pyright. (#432) by seapagan
• Migrate validations to Pydantic v2 syntax (#427) by seapagan

Documentation

• Fix some wording and typos in the web docs (#425) by seapagan

Dependency Updates

• Bump ruff from 0.3.2 to 0.3.3 (#452) by dependabot[bot]
• Bump faker from 24.1.0 to 24.2.0 (#451) by dependabot[bot]
• Bump pydantic from 2.6.3 to 2.6.4 (#450) by dependabot[bot]
• Bump types-passlib from 1.7.7.20240106 to 1.7.7.20240311 (#447) by dependabot[bot]
• Bump asyncclick from 8.1.7.1 to 8.1.7.2 (#446) by dependabot[bot]
• Bump pytest from 8.0.2 to 8.1.1 (#445) by dependabot[bot]
• Bump uvicorn from 0.27.1 to 0.28.0 (#444) by dependabot[bot]
• Bump ruff from 0.3.0 to 0.3.2 (#443) by dependabot[bot]
• Bump mypy from 1.8.0 to 1.9.0 (#442) by dependabot[bot]
• Bump faker from 24.0.0 to 24.1.0 (#441) by dependabot[bot]
• and 22 more dependency updates

Full Changelog | Diff | Patch

v0.5.1

Closed Issues

• Run Tests against Postgres database (#102) by pdrivom

Breaking Changes

• Upgrade docker config to use version 15. Change some ports and env variable usage (#410) by seapagan

New Features

• Add option to disable the '/' route if required (#388) by seapagan
• Allow setting a custom API root path e.g. "/api/v1" to prepend to all routes (#386) by seapagan

Testing

• Fix the Docker config so tests pass (#409) by seapagan

Documentation

• Update .env.example, and remove references to old 'api-admin' script from docs (#407) by seapagan

Dependency Updates

• Update the requirements files to match pyproject.toml (#408) by seapagan
• Bump mkdocs-material from 9.5.9 to 9.5.11 (#406) by dependabot[bot]
• Bump cryptography from 42.0.2 to 42.0.4 (#405) by dependabot[bot]
• Bump aiosqlite from 0.19.0 to 0.20.0 (#404) by dependabot[bot]
• Bump pyright from 1.1.350 to 1.1.351 (#403) by dependabot[bot]
• Bump anyio from 4.2.0 to 4.3.0 (#402) by dependabot[bot]
• Bump pytest from 8.0.0 to 8.0.1 (#401) by dependabot[bot]
• Bump ruff from 0.2.1 to 0.2.2 (#400) by dependabot[bot]
• Bump pydantic-settings from 2.1.0 to 2.2.1 (#399) by dependabot[bot]
• Bump pre-commit from 3.6.1 to 3.6.2 (#397) by dependabot[bot]
• and 12 more dependency updates

Full Changelog | Diff | Patch

A New Hope

This is the long-delayed release of 0.5.0 🥳

There are many breaking changes; check the documentation, discussions and all the 0.5.0 alpha and beta releases for information.

• Make the API an installable package and CLI command (#276) by seapagan
• Convert db to sqlalchemy 2 (#140) by seapagan

Full Changelog | Diff | Patch

The Old Guard

This is the last 'legacy' release. It has a few updates from the 0.4.1 release and will receive no further works, unless there are dependency changes.

All future work will be based on the 0.5.x release.

v0.5.0-beta1

This release pretty much completes the test suite and will soon be ready for merging into the main branch as a full 0.5.0 release.

Closed Issues

• Intermittent test failures with 3.9 and 3.10 (#321) by seapagan

Testing

• Continue writing missing tests (#341) by seapagan
• Continue testing on the api-admin custom CLI command (#313) by seapagan

Dependency Updates

• Bump pyright from 1.1.346 to 1.1.348 (#351) by dependabot[bot]
• Bump mkdocs-swagger-ui-tag from 0.6.7 to 0.6.8 (#349) by dependabot[bot]
• Bump pymarkdownlnt from 0.9.15 to 0.9.16 (#348) by dependabot[bot]
• Bump pyfakefs from 5.3.2 to 5.3.4 (#347) by dependabot[bot]
• Bump uvicorn from 0.25.0 to 0.27.0 (#346) by dependabot[bot]
• Bump asyncclick from 8.1.3.4 to 8.1.7.1 (#345) by dependabot[bot]
• Bump actions/cache from 3 to 4 (#344) by dependabot[bot]
• Bump actions/dependency-review-action from 3 to 4 (#343) by dependabot[bot]
• Bump fastapi from 0.103.0 to 0.109.0 (#339) by dependabot[bot]
• Bump jinja2 from 3.1.2 to 3.1.3 (#336) by dependabot[bot]
• and 15 more dependency updates

Full Changelog | Diff | Patch