feat(PyPI): update metadata for MLRsearch 1.2.1

Change-Id: Ib7d31bcd9bab350a3b2443a15b4d9a533d774cca
Signed-off-by: Vratko Polak <vrpolak@cisco.com>

diff --git a/PyPI/MLRsearch/MANIFEST.in b/PyPI/MLRsearch/MANIFEST.in
deleted file mode 100644 (file)
index 5807327..0000000
--- a/PyPI/MLRsearch/MANIFEST.in
+++ /dev/null
@@ -1,6 +0,0 @@
-
-# Include the README
-include README.rst
-
-# Include the license file
-include LICENSE.txt

diff --git a/PyPI/MLRsearch/README.rst b/PyPI/MLRsearch/README.rst
index de26fad..3df7756 100644 (file)
--- a/PyPI/MLRsearch/README.rst
+++ b/PyPI/MLRsearch/README.rst
@@ -16,6 +16,10 @@ is only a symlink to the original place of tightly coupled CSIT code.
 Change log
 ----------
 
+1.2.1: Updated the readme document.
+
+1.2.0: Changed the output structure to use Goal Result as described in draft-05.
+
 1.1.0: Logic improvements, independent selectors, exceed ratio support,
 better width rounding, conditional throughput as output.
 Implementation relies more on dataclasses, code split into smaller files.
@@ -138,15 +142,15 @@ This is the screen capture of interactive python interpreter
     PDR conditional throughput: 1000000.6730730429
     >>>
 
-Operation logic
----------------
+IETF documents
+--------------
 
-The currently published `IETF draft`_ describes the logic of version 0.4,
-the logic of version 1.1 will be descibed better in the next draft version (-05).
+The currently published `IETF draft`_ describes the logic of version 1.2.0,
+earlier library and draft versions do not match each other that well.
 
 .. _CSIT: https://wiki.fd.io/view/CSIT
 .. _fd.io: https://fd.io/
 .. _LFN: https://www.linuxfoundation.org/projects/networking/
 .. _PyPI: https://pypi.org/project/MLRsearch/
-.. _directory: https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/MLRsearch;hb=refs/heads/master
-.. _IETF draft: https://tools.ietf.org/html/draft-ietf-bmwg-mlrsearch-04
+.. _directory: https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/MLRsearch
+.. _IETF draft: https://tools.ietf.org/html/draft-ietf-bmwg-mlrsearch-05

diff --git a/PyPI/MLRsearch/hints_and_todos.txt b/PyPI/MLRsearch/hints_and_todos.txt
new file mode 100644 (file)
index 0000000..ea1f087
--- /dev/null
+++ b/PyPI/MLRsearch/hints_and_todos.txt
@@ -0,0 +1,7 @@
+toml hint: https://flit.pypa.io/en/stable/pyproject_toml.html
+rst hint: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
+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 MLRsearch library.

diff --git a/PyPI/MLRsearch/pyproject.toml b/PyPI/MLRsearch/pyproject.toml
new file mode 100644 (file)
index 0000000..c9f705a
--- /dev/null
+++ b/PyPI/MLRsearch/pyproject.toml
@@ -0,0 +1,31 @@
+[project]
+name = "MLRsearch"
+version = "1.2.1"
+description = "Library for extending and speeding up througput search."
+license = { file = "LICENSE.txt" }
+readme = { file = "README.rst", content-type = "text/x-rst" }
+requires-python = "~=3.8"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Telecommunications Industry",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.8",
+    "Topic :: System :: Networking",
+]
+keywords = [
+    "binary search", "throughput", "networking", "RFC 2544",
+    "conditional throughput",
+]
+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" },
+]
+
+[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/MLRsearch"

diff --git a/PyPI/MLRsearch/setup.cfg b/PyPI/MLRsearch/setup.cfg
deleted file mode 100644 (file)
index b4abd1b..0000000
--- a/PyPI/MLRsearch/setup.cfg
+++ /dev/null
@@ -1,7 +0,0 @@
-[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

diff --git a/PyPI/MLRsearch/setup.py b/PyPI/MLRsearch/setup.py
deleted file mode 100644 (file)
index f824d15..0000000
--- a/PyPI/MLRsearch/setup.py
+++ /dev/null
@@ -1,52 +0,0 @@
-"""A setup module for setuptools.
-
-See:
-https://packaging.python.org/en/latest/distributing.html
-
-TODO: Move as much as possible into setup.cfg
-"""
-
-from setuptools import setup, find_packages
-from os import path
-from io import open
-
-here = path.abspath(path.dirname(__file__))
-with open(path.join(here, u"README.rst"), encoding=u"utf-8") as f:
-    long_description = f.read()
-
-setup(
-    name=u"MLRsearch",
-    version=u"1.1.0",  # This is currently the only place listing the version.
-    description=u"Library for speeding up binary search using shorter measurements.",
-    long_description=long_description,
-    long_description_content_type=u"text/x-rst",
-    # TODO: Create a separate webpage for MLRsearch library.
-    url=u"https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/MLRsearch;hb=refs/heads/master",
-    author=u"Cisco Systems Inc. and/or its affiliates",
-    author_email=u"csit-dev@lists.fd.io",
-    classifiers=[
-        u"Development Status :: 3 - Alpha",
-        u"Intended Audience :: Science/Research",
-        u"Intended Audience :: Telecommunications Industry",
-        u"License :: OSI Approved :: Apache Software License",
-        u"Programming Language :: Python :: 3.8",
-        u"Topic :: System :: Networking"
-    ],
-    keywords=u"binary search throughput networking",
-    packages=find_packages(exclude=[]),
-    python_requires=u"~=3.8",
-    install_requires=[],
-    # TODO: Include simulator and tests.
-    extras_require={
-    },
-    package_data={
-    },
-    entry_points={
-        u"console_scripts": [
-        ],
-    },
-    project_urls={
-        u"Bug Reports": u"https://jira.fd.io/projects/CSIT/issues",
-        u"Source": u"https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/MLRsearch;hb=refs/heads/master",
-    },
-)

diff --git a/PyPI/jumpavg/hints_and_todos.txt b/PyPI/jumpavg/hints_and_todos.txt
index 6bae0ed..4207205 100644 (file)
--- a/PyPI/jumpavg/hints_and_todos.txt
+++ b/PyPI/jumpavg/hints_and_todos.txt
@@ -2,6 +2,7 @@ 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: Copy improvements from MLRsearch metadata (readme and license extensions).
 TODO: Include simulator and tests.
 TODO: Test which Python versions is the code actually compatible with.
 TODO: Create a separate webpage for jumpavg library.