blob: 61e112617b4b4caa55699152aa35842870a79b54 [file] [log] [blame]
Andrea Campanella01051002021-08-25 11:55:44 +02001DEPRECATED
2==========
3
4`No Maintenance Intended <http://unmaintained.tech/badge.svg)](http://unmaintained.tech/>`_
5
6`VOLTHA 2.6` was the last release that officially used the `pyvoltha` library in any of the VOLTHA components.
7From `2.7` onwards no VOLTHA component is in python, thus the repo has been deprecated, the go equivalent is `voltha-lib-go <https://github.com/opencord/voltha-lib-go>`_. This codebase is going to be removed after the VOLTHA 2.8 release LTS support ends in December 2022.
8
Zack Williams50b6e9e2019-07-17 15:18:08 -07009PyVOLTHA
10========
11
12PyVOLTHA is a collection of shared Python libraries that are use to
13create Python-based
14`VOLTHA <https://wiki.opencord.org/display/CORD/VOLTHA>`__ Device
15Adapters and other Python utilities (CLI, …) that need to work with the
16VOLTHA v2.0 and later Golang core.
17
18Initially PyVOLTHA will target only Python 2.7, but contributors are
19encouraged to write or refactor any library methods to eventually
20support Python 3.6.x or later.
21
22Installation instruction
23------------------------
24
25.. code:: bash
26
27 pip install pyvoltha
28
29Release History
30---------------
31
32+---------+------------+-----------------------------------------------+
33| Version | Date | Notes |
34+=========+============+===============================================+
35| v0.1.0 | 2019-02-01 | Initial pypy release available. This is |
36| | | primarily for testing out pip install support |
37| | | and is not expected to be useful outside of |
38| | | that. |
39+---------+------------+-----------------------------------------------+
40
41Detailed Release History
Chip Bolingde43a702021-01-26 11:46:38 -060042~~~~~~~~~~~~~~~~~~~~~~~~~~~
43
44v2.7.0 (2021-01-27)
45^^^^^^^^^^^^^^^^^^^
46
47- Changed KPI frequency units from 1/10 second to 1 second to match
48 what is implemented in the voltha-lib-go library.
49
50- Changed KPI Event titles from "Ethernet" and "PON" to "ETHERNET_NNI"
51 and "PON_OLT" to match what is implemented in the voltha-lib-go
52 library.
Zack Williams50b6e9e2019-07-17 15:18:08 -070053
54v0.1.0 (2019-02-01)
55^^^^^^^^^^^^^^^^^^^
56
57- Experimental release of pyvoltha to test pip install capabilities.
58 This version has manually created protobuf definitions and will
59 probably not be very usable by any device adapters.
60- This version is not under source control management at this time.
61 Initial VCS support is anticipated in the very near future when
62 portions of this project can be consumed by a device adapter
63 developer.
64- Protobuf files in the proto directory were hand copied over from
65 the voltha-go repository. These will eventually be in a separate repo
66 that developers will need to include.
67- Most all import paths fixed but that does not mean everything works
68- A fair number of original unit tests are working after import
69 changes. Others need work.