Metadata-Version: 2.1
Name: nitk-nest
Version: 0.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
        
        `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.
        
        ## Installation
        Instructions to install `NeST` from source can be found in
        [INSTALL.md](https://gitlab.com/nitk-nest/nest/-/blob/master/INSTALL.md).
        
        ## Documentation
        Instrcutions 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.
        ```
        sudo python -m unittest
        ```
        
        **NOTE**: If tests are run from within a virtual environment, then an additional
        `-E` might be needed for `sudo`
        ```
        sudo -E python -m unittest
        ```
        
        ## Contributing
        - Create an issue if required.
        - Create a merge request containing the necessary changes.
        - Make sure the code adheres to
        [pep8](https://www.python.org/dev/peps/pep-0008/) coding standards.
        
        **NOTE**: Running a script that uses NeST requires root access.
        
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
