shleem 0.0.2

Automate and version datasets generation from data sources.

Automate and version datasets generation from data sources.

import shleem
# mystery code

Contents

• 1 Installation

• 2 Setting up shleem

  • 2.1 Credentials file

• 3 Basic Use

• 4 Contributing

  • 4.1 Installing for development

  • 4.2 Running the tests

  • 4.3 Adding documentation

• 5 Credits

1 Installation

pip install shleem

2 Setting up shleem

shleem uses a couple of simple conventions to handle credentials and refer to MongoDB servers:

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.

3 Basic Use

Pass.

4 Contributing

Package author and current maintainer is Shay Palachy ([e-mail]); You are more than welcome to approach him for help. Contributions are very welcomed.

4.1 Installing for development

Clone:

git clone [e-mail]:shaypal5/shleem.git

Install in development mode:

cd shleem
pip install -e .

4.2 Running the tests

To run the tests use:

pip install pytest pytest-cov coverage
cd shleem
pytest

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.

5 Credits

Created by Shay Palachy ([e-mail]).