Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 1.79 KB

README.rst

File metadata and controls

60 lines (41 loc) · 1.79 KB

astrolabe

Info:Developer tools for testing Drivers against MongoDB Atlas. See GitHub for the latest source.
Author: Prashant Mital

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.5+.

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.5+.

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.