{"id":26059981,"url":"https://github.com/nokia/pcaptoparquet","last_synced_at":"2026-05-15T00:40:15.276Z","repository":{"id":279665065,"uuid":"938052095","full_name":"nokia/pcaptoparquet","owner":"nokia","description":"A package for converting PCAP files to parquet format.","archived":false,"fork":false,"pushed_at":"2025-03-06T12:47:52.000Z","size":49960,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-06T13:40:47.016Z","etag":null,"topics":["csv","json","parquet","pcap"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nokia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-24T10:47:46.000Z","updated_at":"2025-03-06T12:47:55.000Z","dependencies_parsed_at":"2025-02-26T19:32:16.698Z","dependency_job_id":null,"html_url":"https://github.com/nokia/pcaptoparquet","commit_stats":null,"previous_names":["nokia/pcaptoparquet"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nokia%2Fpcaptoparquet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nokia%2Fpcaptoparquet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nokia%2Fpcaptoparquet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nokia%2Fpcaptoparquet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nokia","download_url":"https://codeload.github.com/nokia/pcaptoparquet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242559203,"owners_count":20149326,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csv","json","parquet","pcap"],"created_at":"2025-03-08T13:48:50.240Z","updated_at":"2026-05-15T00:40:15.268Z","avatar_url":"https://github.com/nokia.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pcaptoparquet\n\nThis is a package for converting pcap files primarily to parquet format. CSV and JSON formats are also supported.\n\n## Installation\n\nTo install the package, run the following command:\n\n```sh\npip install pcaptoparquet\n```\n\nOr with a virtual environment:\n\n```sh\npython -m venv \u003cyour_venv\u003e\nsource \u003cyour_venv\u003e/bin/activate   # In windows: .\\\u003cyour_venv\u003e\\Scripts\\activate\npython -m pip install --upgrade pip\npython -m pip install pcaptoparquet\n```\n\n## Usage\n\n### Command Line Interface\n\nTo see all available options:\n\n```sh\npcaptoparquet -h\n```\n\n**Note 1**: Portable executable can be created with pyinstaller but this executable has not been fully tested. Check the Makefile for more information.\n\n**Note 2**: CLI interface was not fully tested in Windows environment. Unit testing is only instrumented for Linux.\n\n### Programming Interface\n\nThe `pcaptoparquet` package provides the `E2EPcap` class for converting pcap files to different formats. Here's how you can use it:\n\n1. Import the `E2EPcap` class from the `pcaptoparquet` package:\n\n```python\nfrom pcaptoparquet import E2EPcap\n```\n\n2. Create an instance of `E2EPcap` with the path to your pcap file:\n\n```python\npcap = E2EPcap('path_to_your_pcap_file')\n```\n\nReplace `'path_to_your_pcap_file'` with the actual path to your pcap file.\n\n3. Use the `export` method of the `E2EPcap` instance to convert the pcap data to a different format:\n\n```python\npcap.export(format='parquet', output='output_directory')\n```\n\nThe `format` parameter specifies the output format. In this example, we're converting the pcap data to parquet format.\n\nThe `output` parameter specifies the directory where the output file will be saved. Replace `'output_directory'` with the actual path to your output directory.\n\nThis is a basic example of how to use the `pcaptoparquet` package. Depending on your needs, you might need to use additional methods or parameters.\n\nRefer to `pcaptoparquet_cli.py` for a more complex example of use. In particular, refer to extensibility options such as application protocol implementations and post-processing callbacks associated to E2EConfig class. Full examples included in tests folder (config and callbacks subfolders).\n\n## Contributing\n\nContributions are welcome. Please follow these steps to contribute:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Make your changes.\n4. Run the tests and code quality checks to ensure everything works correctly.\n5. Commit your changes (`git commit -am 'Add new feature'`).\n6. Push to the branch (`git push origin feature-branch`).\n7. Create a new Pull Request.\n\nPlease make sure to update tests as appropriate.\n\n### Development Installation\n\nAfter cloning the repository, you can set up your development environment:\n\n```sh\npython -m venv \u003cyour_venv\u003e\nsource \u003cyour_venv\u003e/bin/activate   # In windows: .\\\u003cyour_venv\u003e\\Scripts\\activate\npython -m pip install --upgrade pip\npython -m pip install -e .\npython -m pip install black isort pyright flake8 Flake8-pyproject mypy tox coverage build twine\n```\n\nor\n\n```sh\nmake venv\n```\n\n### Testing\n\nThe `pcaptoparquet` package includes a suite of tests to ensure its functionality. These tests are located in the `tests` directory.\n\nTo run the tests, you'll need `tox`, which is a tool for automating testing in multiple Python environments.\n\nHere's how you can run the tests:\n\n```bash\ntox\n```\n\nor\n\n```sh\nmake test\n```\n\nThis command will run all the tests in the `tests` directory and display the results in the terminal.\n\nIf you make changes to the `pcaptoparquet` code, please make sure to run the tests and ensure they all pass before submitting a pull request.\n\nCoverage is also available but only informational for now:\n\n```sh\nmake coverage\n```\n\n### Code Quality Checks\n\nThe `pcaptoparquet` project uses several tools to ensure code quality:\n\n- `black`: for code formatting\n- `isort`: for sorting imports\n- `pyright`: for type checking\n- `flake8`: for linting\n- `mypy`: for static type checking\n\nYou can run these checks using the following commands:\n\n```sh\nblack --check pcaptoparquet_cli.py pcaptoparquet tests\nisort --check-only pcaptoparquet_cli.py pcaptoparquet tests\npyright pcaptoparquet_cli.py pcaptoparquet tests\nflake8 pcaptoparquet_cli.py pcaptoparquet tests\nmypy pcaptoparquet_cli.py pcaptoparquet tests\n```\n\nor\n\n```sh\nmake check\n```\n\nTo automatically fix formatting issues:\n\n```sh\nmake fix\n```\n\n## License\nThis project is licensed under the BSD-3-Clause License. See the `LICENSE` file for more details. Copyright 2025 Nokia.\n\n\n## DeepWiki\nAdditional documentation can be found at [pcaptoparquet](https://deepwiki.com/nokia/pcaptoparquet).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnokia%2Fpcaptoparquet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnokia%2Fpcaptoparquet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnokia%2Fpcaptoparquet/lists"}