The `db-contrib-tool` - MongoDB's tool for contributors.
Project description
db-contrib-tool
The db-contrib-tool
- MongoDB's tools for contributors.
Table of contents
Description
The command line tool with various subcommands:
bisect
- performs an evergreen-aware git-bisect to find the 'last passing version' and 'first failing version' of mongosetup-repro-env
- downloads and installs:- particular MongoDB versions
- debug symbols
- artifacts (including resmoke, python scripts etc)
- python venv for resmoke, python scripts etc
symbolize
- takes stacktraces as input and generates symbolized output of it.
Dependencies
- Python 3.7 or later (python3 from the MongoDB Toolchain is highly recommended)
Installation
Use pipx to install db-contrib-tool that will be
available globally on your machine.
The example of pipx installation with python3 from the MongoDB Toolchain:
$ /opt/mongodbtoolchain/v3/bin/python3 -m pip install pipx
$ /opt/mongodbtoolchain/v3/bin/python3 -m pipx ensurepath
Installing db-contrib-tool:
$ /opt/mongodbtoolchain/v3/bin/python3 -m pipx install db-contrib-tool
Upgrading db-contrib-tool:
$ /opt/mongodbtoolchain/v3/bin/python3 -m pipx upgrade db-contrib-tool
Usage
Print out help message:
$ db-contrib-tool -h
More information on the usage of setup-repro-env
can be found here.
Contributor's Guide (local development)
Install project dependencies
This project uses poetry for dependency management.
$ poetry install
Run command line tool (local development)
$ ENV=DEV poetry run db-contrib-tool -h
Run linters
$ poetry run isort src tests
$ poetry run black src tests
Run tests
$ poetry run pytest
Pre-commit
This project has pre-commit configured. Pre-commit will run
configured checks at git commit time.
To enable pre-commit on your local repository run:
$ poetry run pre-commit install
To run pre-commit manually:
$ poetry run pre-commit run
Test pipx package
Pipx installation recommendations can be found in installation section.
The tool can be installed via pipx from your local repo:
$ /opt/mongodbtoolchain/v3/bin/python3 -m pipx install /path/to/db-contrib-tool
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for db_contrib_tool-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d136be747b0dda715b8422bd04a4985e1e4ca8c6e9ea6b0b2d0e60cf233051fd |
|
MD5 | 9df125703de7f141a6fd3cd1e3e3d7b5 |
|
BLAKE2b-256 | efe52882505a34447560f36263e2ee51091a52728c1802fe4a55b35e4c38b0d1 |