Automate and version datasets generation from data sources.
Project description
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.
3 Basic Use
Pass.
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for shleem-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eeba3a98f36c98b0a3ee6b54dcd65fc7083855aff15aacb9fd1bdd61925e30d9 |
|
MD5 | 418134303ceef8fec9aa3e30a39e6a2b |
|
BLAKE2b-256 | 23b0f2f8bb2d91af0b75b0bcde1063bbcc68042da1872e6385abe39d706a43ba |