Welcome to MongoDB IAM Connection String’s documentation!

MongoDB IAM Connection String

https://img.shields.io/pypi/v/mongodb_iam_connection_string.svg Documentation Status

A CLI and Python Library for configuration AWS IAM authentication with MongoDB URI connection strings.

Features

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install MongoDB IAM Connection String as CLI tool, it is recommended that you use pipx to install this utility within its own virtualenv.

$ pipx install mongodb-iam-connection-string

This is the preferred method to install MongoDB IAM Connection String, as it will always install the most recent stable release.

If you don’t have pipx installed, this pipx installation guide can guide you through the process.

From sources

The sources for MongoDB IAM Connection String can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/darrengruber/mongodb-iam-connection-string

Or download the tarball:

$ curl -OJL https://github.com/darrengruber/mongodb-iam-connection-string/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use MongoDB IAM Connection String as a CLI tool:

$ mongo $(mics 'mycluster.5mha8.mongodb.net')

To use MongoDB IAM Connection String in a project:

# import the class
from mongodb_iam_connection_string import MongoDBIAMConnectionString

# generate a connection string
cluster_address = 'mycluster.5mha8.mongodb.net'
try:
    mongodb_connection_string = str(MongoDBIAMConnectionString(cluster_address))
except InvalidAWSSession:
    # handle this exception
    pass

mongodb_iam_connection_string

mongodb_iam_connection_string package

Submodules

mongodb_iam_connection_string.cli module

MongoDB IAM Connection String

Usage:

mics [–profile=default] <MONGODB_CONNECTION_STRING>

mics (-h | –help) mics (-v | –version)

Options:
--profile=AWS_PROFILE
 The name of the AWS profile to use. [default: default]

-h –help Show this screen. -v –version Show version.

mongodb_iam_connection_string.cli.cli()[source]

mongodb_iam_connection_string.exceptions module

exception mongodb_iam_connection_string.exceptions.InvalidAWSSession[source]

Bases: Exception

Raised when no AWS session can be established

mongodb_iam_connection_string.mics module

class mongodb_iam_connection_string.mics.MongoDBIAMConnectionString(connection_string: str, profile_name: str = 'default')[source]

Bases: object

Module contents

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/darrengruber/mongodb-iam-connection-string/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

MongoDB IAM Connection String could always use more documentation, whether as part of the official MongoDB IAM Connection String docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/darrengruber/mongodb-iam-connection-string/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up mongodb_iam_connection_string for local development.

  1. Fork the mongodb-iam-connection-string repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/mongodb-iam-connection-string.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv mongodb-iam-connection-string
$ cd mongodb-iam-connection-string/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 mongodb_iam_connection_string tests
$ python setup.py test or pytest
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check https://travis-ci.com/darrengruber/mongodb-iam-connection-string/pull_requests and make sure that the tests pass for all supported Python versions.

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

1.0.0 (2020-08-30)

  • First release on PyPI.

Indices and tables