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
Make sure dependencies are installed. Use pipx to install db-contrib-tool that will be available globally on your machine:
$ python3 -m pip install pipx
$ python3 -m pipx ensurepath
Installing db-contrib-tool:
$ python3 -m pipx install db-contrib-tool
Upgrading db-contrib-tool:
$ 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:
$ 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.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b0840a62c5d5bf43b3004e0318e80406cca1e784dcd679a55cd30574b119f6a |
|
MD5 | 7c735904e095b1572c6bf83a42f6a9dc |
|
BLAKE2b-256 | 1f03aa79be14b6ea8f5193def9cb78c18eca08489a73dba0c8550f5abc42f7be |