Metadata-Version: 2.1
Name: nitk-nest
Version: 0.2.1
Summary: NeST: Network Stack Tester
Home-page: https://nitk-nest.github.io/
Author: NITK
Author-email: nest.nitk@gmail.com
License: UNKNOWN
Project-URL: Source, https://gitlab.com/nitk-nest/nest
Description: # NeST: Network Stack Tester
        
        [![pipeline status](https://gitlab.com/nitk-nest/nest/badges/master/pipeline.svg)](https://gitlab.com/nitk-nest/nest/-/commits/master)
        
        `NeST` is a python3 package that handles testbed setup, testbed configuration,
        collecting and visualizing data by providing a user friendly API, addressing
        common issues involved in conducting networking experiments.
        
        The [paper](https://dl.acm.org/doi/abs/10.1145/3404868.3406670) introducing
        NeST was accepted at [ANRW'20](https://irtf.org/anrw/2020/).
        
        `NeST` source code repository is maintained at [GitLab](https://gitlab.com/nitk-nest/nest).
        
        ## Installation
        
        Instructions to install `NeST` can be found in
        [INSTALL.md](https://gitlab.com/nitk-nest/nest/-/blob/master/INSTALL.md).
        
        ## Documentation
        
        The documentation of NeST APIs can be read online at:
        [https://nitk-nest.github.io/docs/](https://nitk-nest.github.io/docs/)
        
        Instructions for generating/building the API documentation can be found in
        [docs/README.md](https://gitlab.com/nitk-nest/nest/-/blob/master/docs/README.md) folder.
        
        ## Unit tests
        
        Tests can be found in `nest/tests` folder.
        Run the below command in the repo's root folder to run the tests.
        
        ```shell
        sudo python3 -m unittest -v
        ```
        
        **NOTE**: NeST requires **root** access currently to create and manage network namespaces.
        
        ## Contributing
        
        To contribute, read [CONTRIBUTING.md](https://gitlab.com/nitk-nest/nest/-/blob/master/CONTRIBUTING.md)
        
Keywords: network,namespace,linux
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
