Skip to content

Commit 735aae9

Browse files
mohierfmohierf
committed
Set version to 0.3.0 and prepare for release
1 parent 20ae0a4 commit 735aae9

File tree

11 files changed

+457
-220
lines changed

11 files changed

+457
-220
lines changed

‎.gitignore

+133-46
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,137 @@
1-
# Project files #
2-
######################
3-
*.egg-info
4-
*.egg-tmp/
5-
.eggs/
6-
build
7-
dist
8-
INSTALLED_FILES
9-
.project
10-
.pydevproject
11-
.settings
12-
.idea
13-
modules/*
14-
15-
# Logs and databases #
16-
######################
17-
*.log*
18-
*.sqlite
19-
*.db*
20-
21-
22-
# OS generated files #
23-
######################
24-
*.pyc
25-
*.DS_Store*
26-
ehthumbs.db
27-
Icon?
28-
Thumbs.db
29-
*.pid
30-
._.*
31-
*~
32-
*.swp
33-
\#*#
34-
35-
*.debug
36-
*pack_distribution.dat
37-
test/tmp/*dat
1+
# Created by .ignore support plugin (hsz.mobi)
2+
### JetBrains template
3+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
4+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
5+
6+
# User-specific stuff:
7+
.idea/workspace.xml
8+
.idea/tasks.xml
9+
.idea/dictionaries
10+
.idea/vcs.xml
11+
.idea/jsLibraryMappings.xml
12+
13+
# Sensitive or high-churn files:
14+
.idea/dataSources.ids
15+
.idea/dataSources.xml
16+
.idea/dataSources.local.xml
17+
.idea/sqlDataSources.xml
18+
.idea/dynamic.xml
19+
.idea/uiDesigner.xml
20+
21+
# Gradle:
22+
.idea/gradle.xml
23+
.idea/libraries
24+
25+
# Mongo Explorer plugin:
26+
.idea/mongoSettings.xml
27+
28+
## File-based project format:
29+
*.iws
30+
31+
## Plugin-specific files:
32+
33+
# IntelliJ
34+
/out/
35+
36+
# mpeltonen/sbt-idea plugin
37+
.idea_modules/
38+
39+
# JIRA plugin
40+
atlassian-ide-plugin.xml
41+
42+
# Crashlytics plugin (for Android Studio and IntelliJ)
43+
com_crashlytics_export_strings.xml
44+
crashlytics.properties
45+
crashlytics-build.properties
46+
fabric.properties
47+
### Python template
48+
# Byte-compiled / optimized / DLL files
49+
__pycache__/
50+
*.py[cod]
51+
*$py.class
52+
53+
# C extensions
54+
*.so
55+
56+
# Distribution / packaging
57+
.Python
3858
env/
59+
build/
60+
develop-eggs/
61+
dist/
62+
downloads/
63+
eggs/
64+
.eggs/
65+
lib/
66+
lib64/
67+
parts/
68+
sdist/
69+
var/
70+
*.egg-info/
71+
.installed.cfg
72+
*.egg
73+
74+
# PyInstaller
75+
# Usually these files are written by a python script from a template
76+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
77+
*.manifest
78+
*.spec
79+
80+
# Installer logs
81+
pip-log.txt
82+
pip-delete-this-directory.txt
83+
84+
# Unit test / coverage reports
85+
htmlcov/
86+
.tox/
87+
.coverage
88+
.coverage.*
89+
.cache
90+
nosetests.xml
91+
coverage.xml
92+
*,cover
93+
.hypothesis/
94+
95+
# Translations
96+
*.mo
97+
*.pot
98+
99+
# Django stuff:
100+
*.log
101+
local_settings.py
102+
103+
# Flask stuff:
104+
instance/
105+
.webassets-cache
106+
107+
# Scrapy stuff:
108+
.scrapy
109+
110+
# Sphinx documentation
111+
docs/_build/
112+
113+
# PyBuilder
114+
target/
115+
116+
# IPython Notebook
117+
.ipynb_checkpoints
118+
119+
# pyenv
120+
.python-version
121+
122+
# celery beat schedule file
123+
celerybeat-schedule
124+
125+
# dotenv
126+
.env
127+
128+
# virtualenv
129+
venv/
130+
ENV/
39131

40-
# Documentation #
41-
#################
42-
docs/build
43-
docs/tools/media/
44-
docs/tools/pages/
132+
# Spyder project settings
133+
.spyderproject
45134

46-
# test and coverage
47-
test/tmp/.cov*
135+
# Rope project settings
136+
.ropeproject
48137

49-
# Pbr
50-
pbr-*.egg/

‎AUTHORS

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Main developpers:
22

3-
Frédéric Mohier <frederic.mohier@gmail.com>
3+
Frédéric Mohier <frederic.mohier@alignak.net>
44

55

66
Contributors:

‎MANIFEST.in

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
include version.py
22
include README.rst
3+
include AUTHORS
34
include LICENSE
45
include requirements.txt
56
recursive-include alignak_module_ws *

‎README.rst

+59-43
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,53 @@ Alignak Web services Module
33

44
*Alignak Web services module*
55

6-
Build status (stable release)
7-
-----------------------------
8-
9-
.. image:: https://travis-ci.org/Alignak-monitoring-contrib/alignak-module-ws.svg?branch=master
6+
.. image:: https://travis-ci.org/Alignak-monitoring-contrib/alignak-module-ws.svg?branch=develop
107
:target: https://travis-ci.org/Alignak-monitoring-contrib/alignak-module-ws
11-
:alt: Unit tests
8+
:alt: Develop branch build status
129

13-
.. image:: https://coveralls.io/repos/Alignak-monitoring-contrib/alignak-module-ws/badge.svg?branch=master&service=github
14-
:target: https://coveralls.io/github/Alignak-monitoring-contrib/alignak-module-ws?branch=master
15-
:alt: Code coverage
10+
.. image:: https://landscape.io/github/Alignak-monitoring-contrib/alignak-module-ws/develop/landscape.svg?style=flat
11+
:target: https://landscape.io/github/Alignak-monitoring-contrib/alignak-module-ws/develop
12+
:alt: Development code static analysis
1613

14+
.. image:: https://coveralls.io/repos/Alignak-monitoring-contrib/alignak-module-ws/badge.svg?branch=develop
15+
:target: https://coveralls.io/r/Alignak-monitoring-contrib/alignak-module-ws
16+
:alt: Development code tests coverage
1717

18-
Build status (development release)
19-
----------------------------------
18+
.. image:: https://badge.fury.io/py/alignak_module_ws.svg
19+
:target: https://badge.fury.io/py/alignak-module-ws
20+
:alt: Most recent PyPi version
2021

21-
.. image:: https://travis-ci.org/Alignak-monitoring-contrib/alignak-module-ws.svg?branch=develop
22-
:target: https://travis-ci.org/Alignak-monitoring-contrib/alignak-module-ws
23-
:alt: Unit tests
22+
.. image:: https://img.shields.io/badge/IRC-%23alignak-1e72ff.svg?style=flat
23+
:target: http://webchat.freenode.net/?channels=%23alignak
24+
:alt: Join the chat #alignak on freenode.net
2425

25-
.. image:: https://coveralls.io/repos/Alignak-monitoring-contrib/alignak-module-ws/badge.svg?branch=develop&service=github
26-
:target: https://coveralls.io/github/Alignak-monitoring-contrib/alignak-module-ws?branch=master
27-
:alt: Code coverage
26+
.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
27+
:target: http://www.gnu.org/licenses/agpl-3.0
28+
:alt: License AGPL v3
2829

29-
Most recent release
30-
-------------------
30+
Installation
31+
------------
3132

32-
.. image:: https://badge.fury.io/py/alignak_module_ws.svg
33-
:target: https://badge.fury.io/py/alignak_module_ws
33+
The installation of this module will copy some configuration files in the Alignak default configuration directory (eg. */usr/local/etc/alignak*). The copied files are located in the default sub-directory used for the modules (eg. *arbiter/modules*).
34+
35+
From PyPI
36+
~~~~~~~~~
37+
To install the module from PyPI:
38+
::
39+
40+
sudo pip install alignak-module-ws
41+
42+
43+
From source files
44+
~~~~~~~~~~~~~~~~~
45+
To install the module from the source files (for developing purpose):
46+
::
47+
48+
git clone https://github.com/Alignak-monitoring-contrib/alignak-module-ws
49+
cd alignak-module-ws
50+
sudo pip install . -e
51+
52+
**Note:** *using `sudo python setup.py install` will not correctly manage the package configuration files! The recommended way is really to use `pip`;)*
3453

3554

3655
Short description
@@ -43,28 +62,33 @@ This module for Alignak exposes some Alignak Web Services:
4362
* POST /alignak_command that will notify an external command to the Alignak framework
4463

4564

46-
47-
Installation
65+
Web Services
4866
------------
4967

50-
From PyPI
51-
~~~~~~~~~
52-
To install the module from PyPI:
68+
Get Alignak state
69+
~~~~~~~~~~~~~~~~~
70+
To get Alignak daemons states, GET on the `alignak_map` endpoint:
5371
::
5472

55-
pip install alignak-module-web-services
73+
$wget http://demo.alignak.net:8888/alignak_map
5674

75+
$cat alignak_map
5776

58-
From source files
59-
~~~~~~~~~~~~~~~~~
60-
To install the module from the source files:
77+
78+
Send external command
79+
~~~~~~~~~~~~~~~~~~~~~
80+
To send an external command, JSON post on the `command` endpoint:
6181
::
6282

63-
git clone https://github.com/Alignak-monitoring-contrib/alignak-module-ws
64-
cd alignak-module-ws
65-
pip install -r requirements
66-
python setup.py install
83+
$curl -X POST -H "Content-Type: application/json" -d '{
84+
"command": "PROCESS_HOST_CHECK_RESULT",
85+
"element": "always_down",
86+
"parameters": "0;Host is UP and running"
87+
}' "http://demo.alignak.net:8888/command"
88+
89+
{"_status": "ok", "_result": "PROCESS_HOST_CHECK_RESULT;always_down;0;Host is UP and running"}
6790

91+
**Note:** for the available external commands, see the `Alignak documentation chapter on the external commands <http://alignak-doc.readthedocs.io/en/latest/20_annexes/external_commands_list.html>`_.
6892

6993
Configuration
7094
-------------
@@ -79,16 +103,8 @@ To configure an Alignak daemon to use this module:
79103

80104
**Note** that currently the SSL part of this module as not yet been tested!
81105

106+
82107
Bugs, issues and contributing
83108
-----------------------------
84109

85-
Please report any issue using the project `GitHub repository: <https://github.com/Alignak-monitoring-contrib/alignak-module-ws/issues>`_.
86-
87-
License
88-
-------
89-
90-
Alignak Module External commands is available under the `GPL version 3 license`_.
91-
92-
.. _GPL version 3 license: http://opensource.org/licenses/GPL-3.0
93-
.. _Alignak monitoring contrib: https://github.com/Alignak-monitoring-contrib
94-
.. _PyPI repository: <https://pypi.python.org/pypi>
110+
Contributions to this project are welcome and encouraged ... `issues in the project repository <https://github.com/alignak-monitoring-contrib/alignak-module-ws/issues>`_ are the common way to raise an information.

‎alignak_module_ws/ALIGNAKETC/__init__.py ‎alignak_module_ws/etc/__init__.py

File renamed without changes.

‎alignak_module_ws/ALIGNAKETC/arbiter/modules/mod-ws.cfg ‎alignak_module_ws/etc/arbiter/modules/mod-ws.cfg

File renamed without changes.

‎requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
alignak_setup
1+
# Nothing special except:
22
requests
33
cherrypy

0 commit comments

Comments
 (0)