drivers-atlas-testing

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

drivers-atlas-testing

★ 8 Open GitHub ↗

Drivers Atlas Testing

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> [!IMPORTANT]
> This repository is no longer maintained. See [DRIVERS-3114](https://jira.mongodb.org/browse/DRIVERS-3114) for context.

# astrolabe

[![Documentation Status](https://readthedocs.org/projects/drivers-atlas-testing/badge/?version=latest)](http://drivers-atlas-testing.readthedocs.io/en/latest/?badge=latest)

Developer tools for testing
[Drivers](https://docs.mongodb.com/ecosystem/drivers/) against [MongoDB
Atlas](https://www.mongodb.com/cloud/atlas). See
[GitHub](https://github.com/mongodb-labs/drivers-atlas-testing) 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](https://docs.atlas.mongodb.com/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.9+.

## Installation

Astrolabe can be installed with [pip](http://pypi.python.org/pypi/pip):

```bash
python -m pip install astrolabe
```

You can also download the project source and do:

```bash
python -m pip install .
```

## Dependencies

Astrolabe supports CPython 3.9+.

Astrolabe requires [Click](https://pypi.org/project/click/),
[requests](https://pypi.org/project/requests/),
[PyMongo](https://pypi.org/project/pymongo/),
[dnspython](https://pypi.org/project/pymongo/),
[PyYAML](https://pypi.org/project/PyYAML/), and
[junitparser](https://pypi.org/project/junitparser/).

## Documentation

Documentation is available on [ReadtheDocs](http://drivers-atlas-testing.readthedocs.io/en/latest/).

To build the documentation, you will need to install
[mkdocs](https://www.mkdocs.org/getting-started/).

Run `mkdocs serve` to see a live view of the docs.

## Linting and Formatting

This repo uses [pre-commit](https://pypi.org/project/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:

``` bash
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:

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

drivers-atlas-testing

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README