# 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).
**NOTE**: NeST is currently in beta stage.
## Installation
Instructions to install `NeST` can be found in
[install.rst](https://gitlab.com/nitk-nest/nest/-/blob/master/docs/source/user/install.rst).
## Examples
Several examples, that explain the basic APIs and features of NeST, are
available in the [examples directory](https://gitlab.com/nitk-nest/nest/-/tree/master/examples).
## Documentation
The documentation of NeST APIs can be read online at:
[https://nest.nitk.ac.in/docs/](https://nest.nitk.ac.in/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)
Raw data
{
"_id": null,
"home_page": "https://nest.nitk.ac.in/",
"name": "nest",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <4",
"maintainer_email": "",
"keywords": "network,namespace,linux",
"author": "NITK",
"author_email": "nest@nitk.edu.in",
"download_url": "https://files.pythonhosted.org/packages/33/22/1b5d9d343e35c0c79260831e5b9268ad717341b84d85bdd3e40c58fe2b1f/nest-0.4.2.tar.gz",
"platform": null,
"description": "# NeST: Network Stack Tester\n\n[![pipeline status](https://gitlab.com/nitk-nest/nest/badges/master/pipeline.svg)](https://gitlab.com/nitk-nest/nest/-/commits/master)\n\n`NeST` is a python3 package that handles testbed setup, testbed configuration,\ncollecting and visualizing data by providing a user friendly API, addressing\ncommon issues involved in conducting networking experiments.\n\nThe [paper](https://dl.acm.org/doi/abs/10.1145/3404868.3406670) introducing\nNeST was accepted at [ANRW'20](https://irtf.org/anrw/2020/).\n\n`NeST` source code repository is maintained at [GitLab](https://gitlab.com/nitk-nest/nest).\n\n**NOTE**: NeST is currently in beta stage.\n\n## Installation\n\nInstructions to install `NeST` can be found in\n[install.rst](https://gitlab.com/nitk-nest/nest/-/blob/master/docs/source/user/install.rst).\n\n## Examples\n\nSeveral examples, that explain the basic APIs and features of NeST, are\navailable in the [examples directory](https://gitlab.com/nitk-nest/nest/-/tree/master/examples).\n\n## Documentation\n\nThe documentation of NeST APIs can be read online at:\n[https://nest.nitk.ac.in/docs/](https://nest.nitk.ac.in/docs/)\n\nInstructions for generating/building the API documentation can be found in\n[docs/README.md](https://gitlab.com/nitk-nest/nest/-/blob/master/docs/README.md) folder.\n\n## Unit tests\n\nTests can be found in `nest/tests` folder.\nRun the below command in the repo's root folder to run the tests.\n\n```shell\nsudo python3 -m unittest -v\n```\n\n**NOTE**: NeST requires **root** access currently to create and manage network namespaces.\n\n## Contributing\n\nTo contribute, read [CONTRIBUTING.md](https://gitlab.com/nitk-nest/nest/-/blob/master/CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": "",
"summary": "NeST: Network Stack Tester",
"version": "0.4.2",
"project_urls": {
"Homepage": "https://nest.nitk.ac.in/",
"Source": "https://gitlab.com/nitk-nest/nest"
},
"split_keywords": [
"network",
"namespace",
"linux"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c26b385f8e998d4d72d69da6ee51e05e1752c91bee04c9e8298b7c29a62c530",
"md5": "0ab7e31070f70b104a36c6587e40ac0c",
"sha256": "2f693072e0d5f5a5e3dd0c123ff7892a9bf82f560a85bef538bc832fa8b16359"
},
"downloads": -1,
"filename": "nest-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ab7e31070f70b104a36c6587e40ac0c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6, <4",
"size": 157355,
"upload_time": "2023-07-03T17:53:37",
"upload_time_iso_8601": "2023-07-03T17:53:37.848837Z",
"url": "https://files.pythonhosted.org/packages/5c/26/b385f8e998d4d72d69da6ee51e05e1752c91bee04c9e8298b7c29a62c530/nest-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33221b5d9d343e35c0c79260831e5b9268ad717341b84d85bdd3e40c58fe2b1f",
"md5": "8d8aa6ba42ba9677948eaac744870153",
"sha256": "063ff879a91d9fb34007a91f48d2be0c9accb67eb1cf79e859ab2168db0a41ea"
},
"downloads": -1,
"filename": "nest-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "8d8aa6ba42ba9677948eaac744870153",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <4",
"size": 104317,
"upload_time": "2023-07-03T17:53:40",
"upload_time_iso_8601": "2023-07-03T17:53:40.445755Z",
"url": "https://files.pythonhosted.org/packages/33/22/1b5d9d343e35c0c79260831e5b9268ad717341b84d85bdd3e40c58fe2b1f/nest-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-03 17:53:40",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "nitk-nest",
"gitlab_project": "nest",
"lcname": "nest"
}