Marvin engine
REPLACE: Add here the list of requirements. For example:
_REPLACE: Add here the best way to install this engine
First, create a new virtualenv
mkvirtualenv marvin_sample_engine_env
Now install the development dependencies
pip install -r requirements.txt
You are now ready to code.
It`s very important. All development dependencies should be added to setup.py.
This project uses py.test as test runner and Tox to manage virtualenvs.
To run all tests use the following command
marvin test
To run specific test
marvin test tests/test_file.py::TestClass::test_method
The project documentation is written using Jupyter notebooks. You can start the notebook server from the command line by running the following command
marvin notebook
Use notebooks to demonstrate how to use the lib features. It can also be useful to show some use cases.
marvin pkg-bumpversion [patch|minor|major] git add . && git commit -m "Bump version"
marvin pkg-createtag git push origin master --follow-tags
The default log level is set to WARNING. You can change the log level at runtime setting another value to one of the following environment variable: MARVIN_SAMPLE_ENGINE_LOG_LEVEL or LOG_LEVEL. The available values are CRITICAL, ERROR, WARNING, INFO and DEBUG.
Be careful using LOG_LEVEL, it may affect another lib.