https://github.com/softwareone-platform/pytest-capsqlalchemy
Pytest plugin to allow capturing SQLAlchemy queries.
https://github.com/softwareone-platform/pytest-capsqlalchemy
Last synced: 5 months ago
JSON representation
Pytest plugin to allow capturing SQLAlchemy queries.
- Host: GitHub
- URL: https://github.com/softwareone-platform/pytest-capsqlalchemy
- Owner: softwareone-platform
- License: apache-2.0
- Created: 2025-03-03T09:54:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-06T13:13:58.000Z (8 months ago)
- Last Synced: 2025-10-06T15:14:10.304Z (8 months ago)
- Language: Python
- Size: 1.09 MB
- Stars: 14
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# pytest-capsqlalchemy
[](https://img.shields.io/github/v/release/softwareone-platform/pytest-capsqlalchemy)
[](https://img.shields.io/pypi/pyversions/pytest-capsqlalchemy)
[](https://github.com/softwareone-platform/pytest-capsqlalchemy/actions/workflows/main.yml?query=branch%3Amain)
[](https://sonarcloud.io/summary/new_code?id=softwareone-platform_pytest-capsqlalchemy)
[](https://sonarcloud.io/summary/new_code?id=softwareone-platform_pytest-capsqlalchemy)
[](https://img.shields.io/github/commit-activity/m/softwareone-platform/pytest-capsqlalchemy)
[](https://img.shields.io/github/license/softwareone-platform/pytest-capsqlalchemy)
Pytest plugin to allow capturing SQLAlchemy queries.
- **Github repository**:
- **Documentation**
## Getting Started
### 1. Clone the repository
First, clone the repository from GitHub:
```bash
git clone https://github.com/softwareone-platform/pytest-capsqlalchemy
```
### 2. Set Up Your Development Environment
Then, install the environment and the pre-commit hooks with
```bash
make install
```
This will also generate your `uv.lock` file
### 3. Run the pre-commit hooks
Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
```bash
uv run pre-commit run -a
```
### 4. Run the tests
The tests require a Postgres database to be running. If you prefer to use a local database you need to edit the `.env` file with
the connection options for it. Alternatively, you can use the provided `docker-compose.yaml` to run it within docker -- all you
need to do is run:
```bash
docker compose up test_postgres -d
```
And after that to run the tests:
```bash
make test
```
### 5. Commit the changes
Lastly, commit the changes made by the two steps above to your repository.
```bash
git add .
git commit -m 'Fix formatting issues'
git push origin main
```
You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).