Contribute

First clone repo, install dev dependencies, and install the module under evaluation mode.

git clone https://github.com/episodeyang/ml_logger.git
cd ml_logger && cd ml_logger && pip install -r requirements-dev.txt
pip install -e .

Testing local-mode

You should be inside the ml_logger/ml_logger folder

pwd
# should print ~> ml_logger/ml_logger
make test

Testing with a server

In order to submit a pull-request, you also need to test with a server. First run (in a separate console)

python -m ml_logger.server --log-dir /tmp/ml-logger-debug

alternatively do:

make start-test-server

Then run this test script with the option:

python -m pytest tests --capture=no --log-dir http://0.0.0.0:8081

or do

make test-with-server

Your PR should have both of these two tests working. ToDo: add CI to this repo.

To Publish

You need twine, rst-lint etc, which are included in the requirements-dev.txt file.