SONATA's Service Platform analysis framework. son-analyze creates an analysis session to study a service. Inside this session, the end-user can program an analysis on a service's metrics using pandas. This tools uses Jupyter to offer a ready-to-use web-IDE. It also contains a set of libraries to speak with the Sonata Platform that are automatically installed in the session.
This tool is composed of multiple libraries.
- The main
son-analyzelibrary contains some core features and the command line entry-points. - The
son-scikitlibrary use theson-analyzebase structures and functions to bridge Sonata data with SciPy and pandas.
- If the new library is directly used by
son-analyze: - Add the new library to:
setup.pyrequirements.in- Regenerate the dependencies:
pip-compile requirements.in - If the new library is only used for testing, developing:
- Add the new library to:
dev-requirements.in- Regenerate the dependencies:
pip-compile dev-requirements.in
The code is checked and tested by flake8, pylint, mypy and py.test.
Inside a virtualenv environment:
- To Launch all the test:
scripts/all.py - Only launch a specific tool globally or on specific files:
- flake8:
scripts/flake8.sh - pylint:
scripts/pylint.sh setup.py - mypy:
scripts/mypy.sh setup.py src/son_analyze/cli/main.py - py.test:
scripts/py.test.sh
You can also directly use these tools: mypy src/son_analyze/cli/main.py.
With Docker, the CI tests can be locally run with:
utils/ci/build_01_checks_and_unit_tests.sh
son-analyze(at runtime)son-scikit(at runtime)son-analyze>= 0.0.1 (Apache License Version 2.0)- pyaml >=15.8.2 (WTFPL)
- typing >=3.5.0.1 (PSF)
- pandas >=0.18.1 (BSD)
- Jupyter >=4.0 (BSD)
- During development and testing
- colorama >=0.3.7 (BSD)
- pip-tools >=1.6 (BSD)
- pytest >=2.9.0 (MIT)
- flake8 >=2.5.4 (MIT)
- mypy-lang >=0.3.1 (MIT)
- pylint >=1.5.4 (GPL): Pylint is used to check the source code for programming errors. It is done by calling the main
pylintexecutable over this repository's files. No feature is built upon this tool. This dependency doesn't create a derivative work therefore it doesn't trigger the copyleft effect. - requests_mock >= 1.0.0 (Apache License Version 2.0)
- pytest-capturelog >= 0.7 (MIT)
You may contribute to son-analyze similarly to other SONATA (sub-) projects, i.e. by creating pull requests. The PR code must abide by the flake8 (pep8) and pylint rules.
Ansible & Virtualenv are used to setup the development environment on Ubuntu 14.04:
- Base packages installation
sudo ansible-playbook install.ymlsudo ansible-playbook dev.install.yml- Virtualenv environment creation
virtualenv -p python3 venv- Environment activation
source venv/bin/activate- (Optional) Environment deactivation
deactivate- Dependencies installation
pip3 install -rrequirements.txt -rdev-requirements.txt- Installing
son-analyze python setup.py develop
son-analyze creates an environment based on the SciPy and Jupyter.
- Start by creating the required image on the host with:
son-analyze bootstrap- It will download the official Jupyter Docker image and create a new custom Docker image. This new image contains a SciPy Sonata library with its required dependencies.
- Enter the environment with:
son-analyze run- This command will start a Docker container.
- (Optional) to stop the environment, simply hit
Ctrl-cin the console. - Browse
http://localhost:8888. - Some code examples are provided in the
examplesdirectory (File > Open File).
This SONATA son-analyze software is published under Apache 2.0 license. Please see the LICENSE file for more details.
- Check https://www.reddit.com/r/scipy/ for some SciPy information.
- Sonata-nfv: the SONATA project's website
The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
- Geoffroy Chollon (cgeoffroy)
- Steven Van Rossem (stevenvanrossem)
- Please use the GitHub issues to report bugs.
- You may use the mailing list [email protected]