Skip to content

blink1073/drivers-atlas-testing

 
 

Repository files navigation

astrolabe

Developer tools for testing Drivers against MongoDB Atlas. See GitHub for the latest source.

About

The Astrolabe distribution contains tools for automating Atlas operations and running Atlas Planned Maintenance tests. The atlasclient package provides programmatic access to the MongoDB Atlas API via a fluent interface. The astrolabe package provides a convenient, command-line interface to the atlasclient and also contains the test harnesses necessary to run Atlas Planned Maintenance specification tests.

Astrolabe supports Python 3.7+.

Installation

Astrolabe can be installed with pip:

python -m pip install astrolabe

You can also download the project source and do:

python -m pip install .

Dependencies

Astrolabe supports CPython 3.7+.

Astrolabe requires Click, requests, PyMongo, dnspython, PyYAML, and junitparser.

Documentation

Documentation is available at github.io.

To build the documentation, you will need to install sphinx. Documentation can be generated by running:

make html

in the docs/ directory. Generated documentation can be found in the docs/build/html/ directory.

Linting and Formatting

This repo uses pre-commit for managing linting. pre-commit performs various checks on the files and uses tools that help follow a consistent style within the repo.

To set up pre-commit locally, run:

brew install pre-commit
pre-commit install

To run pre-commit manually, run pre-commit run --all-files.

To run a manual hook like shellcheck manually, run:

pre-commit run --all-files --hook-stage manual shellcheck

About

Drivers Atlas Testing

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 79.8%
  • Shell 12.4%
  • Ruby 3.0%
  • Go 2.5%
  • PHP 2.3%