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
- README.md
- downloads and installs:
- particular MongoDB versions
- debug symbols
- artifacts (including resmoke, python scripts etc)
- python venv for resmoke, python scripts etc
symbolize
- README.md
- Symbolizes stacktraces from recent
mongod
andmongos
binaries compiled in Evergreen, including patch builds, mainline builds, and release/production builds. - Requires authenticating to an internal MongoDB symbol mapping service.
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
Versioning
This project uses semver for versioning.
Please include a description what is added for each new version in CHANGELOG.md
.
Code Review
Please open a Github Pull Request for code review.
This project uses the Evergreen Commit Queue.
Add a PR comment with evergreen merge
to trigger a merge.
Deployment
Deployment to pypi is automatically triggered on merges to main.
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.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4541f8569e444a021b7fc22695be23a74e8eae9339e52f7b175e6bd5f714090d |
|
MD5 | 6b4bd39eac357b16e23836ddd99639e1 |
|
BLAKE2b-256 | f8277e7ee0d06e289d795be1c5f1781e797e3ad1f926ad36bc4bdb309bc34d54 |