Skip to main content

Automate and version datasets generation from data sources.

Project description

PyPI-Status PyPI-Versions Build-Status Codecov LICENCE

Automate and version datasets generation from data sources.

import shleem
# mystery code

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.

4   Contributing

Package author and current maintainer is Shay Palachy (shay.palachy@gmail.com); You are more than welcome to approach him for help. Contributions are very welcomed.

4.1   Installing for development

Clone:

git clone git@github.com: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 (shay.palachy@gmail.com).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for shleem, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size shleem-0.0.2-py2.py3-none-any.whl (13.7 kB) File type Wheel Python version 3.6 Upload date Hashes View
Filename, size shleem-0.0.2.tar.gz (25.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page