1.2.1 Credentials file

You must set up a credentials file for shleem to use. Create a .shleem/shleem_credentials.yml file in your home folder, populating it with your MongoDB credentials, using an identical structure to the inner structure of the envs configuration parameters:

environment_name:
  server_name:
    reading:
      username: reading_username
      password: password1
    writing:
      username: writing_username
      password: password2

You can extend this to include any number of environments and servers.

1.4.1 Installing for development

Clone:

git clone git@github.com:shaypal5/shleem.git

Install in development mode:

cd shleem
pip install -e .

1.4.2 Running the tests

To run the tests use:

pip install pytest pytest-cov coverage
cd shleem
pytest

1.4.3 Adding documentation

The project is documented using the numpy docstring conventions, which were chosen as they are perhaps the most widely-spread conventions that are both supported by common tools such as Sphinx and result in human-readable docstrings. When documenting code you add to this project, follow these conventions.