+++ /dev/null
-
-# Include the README
-include README.rst
-
-# Include the license file
-include LICENSE.txt
--- /dev/null
+# Jumpavg library
+
+## Origins
+
+This library was developed as anomaly detection logic
+for [PAL](https://wiki.fd.io/view/CSIT/Design_Optimizations#Presentation_and_Analytics_Layer "Presentation and Analysis Layer")
+of [CSIT](https://wiki.fd.io/view/CSIT "Continuous System and Integration Testing")
+project of [fd.io](https://fd.io/ "Fast Data"),
+one of [LFN](https://www.linuxfoundation.org/projects/networking/ "Linux Foundation Networking") projects.
+
+Currently still being primarily used in PAL's successor [CSIT-DASH](https://csit.fd.io).
+
+In order to make this code available in [PyPI](https://pypi.org/ "Python Package Index"),
+the setuputils stuff has been added,
+and the code has been moved into a separate [directory](https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/jumpavg),
+in order to not intervere of otherwise tightly coupled CSIT code.
+
+## Usage
+
+TODO.
+
+## Change log
+
+TODO: Move into a separate file?
+
++ 0.4.0: Added "unit" and "sbps" parameters so information content
+ is reasonable even if sample values are below one.
+
++ 0.3.0: Considerable speedup by avoiding unneeded copy. Dataclasses used.
+ Mostly API compatible, but repr looks different.
+
++ 0.2.0: API incompatible changes. Targeted to Python 3 now.
+
++ 0.1.3: Changed stdev computation to avoid negative variance due to rounding errors.
+
++ 0.1.2: First version published in PyPI.
+++ /dev/null
-Jumpavg library
-===============
-
-Origins
--------
-
-This library was developed as anomaly detection logic
-for PAL_ (Presentation and Analysis Layer)
-of CSIT_ (Continuous System and Integration Testing)
-project of fd.io_ (Fast Data), one of LFN_
-(Linux Foundation Networking) projects.
-
-Currently still being primarily used in PAL's successor CSIT-DASH_.
-
-In order to make this code available in PyPI_ (Python Package Index),
-the setuputils stuff has been added,
-and the code has been moved into a separate directory_,
-in order to not intervere of otherwise tightly coupled CSIT code.
-
-Usage
------
-
-TODO.
-
-Change log
-----------
-
-TODO: Move into separate file?
-
-0.4.0: Added "unit" and "sbps" parameters so information content
- is reasonable even if sample values are below one.
-
-0.3.0: Considerable speedup by avoiding unneeded copy. Dataclasses used.
- Mostly API compatible, but repr looks different.
-
-0.2.0: API incompatible changes. Targeted to Python 3 now.
-
-0.1.3: Changed stdev computation to avoid negative variance due to rounding errors.
-
-0.1.2: First version published in PyPI.
-
-.. _PAL: https://wiki.fd.io/view/CSIT/Design_Optimizations#Presentation_and_Analytics_Layer
-.. _CSIT: https://wiki.fd.io/view/CSIT
-.. _CSIT-DASH: https://csit.fd.io
-.. _fd.io: https://fd.io/
-.. _LFN: https://www.linuxfoundation.org/projects/networking/
-.. _PyPI: https://pypi.org/
-.. _directory: https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/jumpavg;hb=refs/heads/master
--- /dev/null
+toml hint: https://flit.pypa.io/en/stable/pyproject_toml.html
+md hint: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
+build hint: https://packaging.python.org/en/latest/tutorials/packaging-projects/
+
+TODO: Include simulator and tests.
+TODO: Test which Python versions is the code actually compatible with.
+TODO: Create a separate webpage for jumpavg library.
--- /dev/null
+[project]
+name = "jumpavg"
+version = "0.4.0"
+description = "Library for locating changes in time series by grouping results."
+authors = [
+ { name = "Cisco Systems Inc. and/or its affiliates", email = "csit-dev@lists.fd.io" },
+]
+maintainers = [
+ { name = "Vratko Polak", email = "vrpolak@cisco.com" },
+ { name = "Tibor Frank", email = "tifrank@cisco.com" },
+]
+keywords = ["progression", "regression", "anomaly detection", "statistics", "bits" ]
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+ "Development Status :: 3 - Alpha",
+ "Intended Audience :: Science/Research",
+ "License :: OSI Approved :: Apache Software License",
+ "Natural Language :: English",
+ "Operating System :: OS Independent",
+ "Programming Language :: Python :: 3.8",
+ "Topic :: Scientific/Engineering :: Information Analysis",
+]
+
+[project.urls]
+"Bug Tracker" = "https://jira.fd.io/projects/CSIT/issues"
+"Source" = "https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/jumpavg"
+++ /dev/null
-[metadata]
-# This includes the license file in the wheel.
-license_file = LICENSE.txt
-
-[bdist_wheel]
-# TODO: Make the code work both on Python 2 and 3.
-universal=0
+++ /dev/null
-#!/usr/bin/env python3
-
-"""A setup module for setuptools.
-
-See:
-https://packaging.python.org/en/latest/distributing.html
-"""
-
-from os import path
-from io import open
-
-from setuptools import setup, find_packages
-
-here = path.abspath(path.dirname(__file__))
-with open(path.join(here, "README.rst"), encoding="utf-8") as f:
- long_description = f.read()
-
-setup(
- name="jumpavg",
- version="0.4.0", # This is currently the only place listing the version.
- description=(
- "Library for locating changes in time series by grouping results."
- ),
- long_description=long_description,
- long_description_content_type="text/x-rst",
- # TODO: Create a separate webpage for jumpavg library.
- url=(
- "https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/jumpavg"
- ";hb=refs/heads/master"
- ),
- author="Cisco Systems Inc. and/or its affiliates",
- author_email="csit-dev@lists.fd.io",
- classifiers=[
- "Development Status :: 3 - Alpha",
- "Intended Audience :: Science/Research",
- # Pick your license as you wish
- "License :: OSI Approved :: Apache Software License",
- "Natural Language :: English",
- # TODO: Test which Python versions is the code compatible with.
- "Programming Language :: Python :: 3.8",
- "Topic :: Scientific/Engineering :: Information Analysis",
- ],
- keywords="progression regression anomaly detection statistics bits",
- packages=find_packages(exclude=[]),
- python_requires="~=3.8",
- install_requires=[],
- # TODO: Include simulator and tests.
- extras_require={},
- package_data={},
- entry_points={
- "console_scripts": [],
- },
- project_urls={
- "Bug Reports": "https://jira.fd.io/projects/CSIT/issues",
- "Source": (
- "https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/jumpavg"
- ";hb=refs/heads/master"
- ),
- },
-)
Code Review / csit.git / commitdiff