Merge pull request #15 from amlight/fix/update_readme

[Fix] Updated README.rst and bumped 2022.1.0

CHANGELOG.rst

@@ -0,0 +1,39 @@
+#########
+Changelog
+#########
+All notable changes to the flow_stats NApp will be documented in this file.
+
+[UNRELEASED] - Under development
+********************************
+Added
+=====
+
+Changed
+=======
+
+Deprecated
+==========
+
+Removed
+=======
+
+Fixed
+=====
+
+Security
+========
+
+[2022.1.0] - 2022-02-08
+***********************
+
+Added
+=====
+- [Issue 12] Enhanced and standardized setup.py `install_requires` to install pinned dependencies
+- [Issue 4] Add setup.py and requirements
+- [Issue 9] Improve flow_stats handler to avoid reset generic_flows before having all multiple parts
+
+Fixed
+=====
+- [Issue 13] GET /api/amlight/flow_stats/flow/stats/ not found
+- [Issue 8] Fix multipart flow stats reply to avoid data loss and race conditions
+- [Issue 5] Removing flow_history from flow_stats as a result of performance issues

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 FIU/AmLight Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -1,6 +1,61 @@
+|Tag| |License|
+
+.. raw:: html
+
+  <div align="center">
+    <h1><code>amlight/flow_stats</code></h1>
+
+    <strong> Napp responsible for providing a Generic Flow and stats </strong>
+
+    <h3><a href="https://kytos-ng.github.io/api/flow_stats.html">OpenAPI Docs</a></h3>
+  </div>
+
+
 Overview
 ========
-# TODO: <<<< Insert here your NApp description >>>>
+Napp responsible for providing a Generic Flow and stats 
+
+Installing
+==========
+
+To install this NApp, first, make sure to have the same venv activated as you have ``kytos`` installed on:
+
+.. code:: shell
+
+   $ git clone https://github.com/amlight/flow_stats.git
+   $ cd flow_stats
+   $ python setup.py develop
 
 Requirements
-============
+============
+
+- `kytos/of_core <https://github.com/kytos-ng/of_core>`_
+
+
+Events
+======
+
+Subscribed
+----------
+
+- ``kytos/of_core.v0x01.messages.in.ofpt_stats_reply``
+- ``kytos/of_core.v0x04.messages.in.ofpt_multipart_reply``
+
+
+.. TAGs
+
+.. |License| image:: https://img.shields.io/github/license/amlight/flow_stats.svg
+   :target: https://github.com/amlight/flow_stats/blob/master/LICENSE
+.. |Build| image:: https://scrutinizer-ci.com/g/amlight/flow_stats/badges/build.png?b=master
+  :alt: Build status
+  :target: https://scrutinizer-ci.com/g/amlight/flow_stats/?branch=master
+.. |Coverage| image:: https://scrutinizer-ci.com/g/amlight/flow_stats/badges/coverage.png?b=master
+  :alt: Code coverage
+  :target: https://scrutinizer-ci.com/g/amlight/flow_stats/?branch=master
+.. |Quality| image:: https://scrutinizer-ci.com/g/amlight/flow_stats/badges/quality-score.png?b=master
+  :alt: Code-quality score
+  :target: https://scrutinizer-ci.com/g/amlight/flow_stats/?branch=master
+.. |Stable| image:: https://img.shields.io/badge/stability-stable-green.svg
+   :target: https://github.com/amlight/flow_stats
+.. |Tag| image:: https://img.shields.io/github/tag/amlight/flow_stats.svg
+   :target: https://github.com/amlight/flow_stats/tags

kytos.json

@@ -3,9 +3,9 @@
   "username": "amlight",
   "name": "flow_stats",
   "description": "Store flow information and show statistics about them.",
-  "version": "0.1",
+  "version": "2022.1.0",
   "napp_dependencies": ["kytos/of_core"],
   "license": "",
   "tags": [],
-  "url": ""
+  "url": "https://github.com/amlight/flow_stats"
 }

setup.py

@@ -23,7 +23,7 @@
 
 NAPP_NAME = 'flow_stats'
 NAPP_USERNAME = 'amlight'
-NAPP_VERSION = '0.1'
+NAPP_VERSION = '2022.1.0'
 
 # Kytos var folder
 VAR_PATH = BASE_ENV / 'var' / 'lib' / 'kytos'