# PDZ-Tool
**PDZ-Tool** is a Python library for reading PDZ files and converting them into CSV or JSON formats. PDZ files are commonly used to store data from X-ray fluorescence (XRF) instruments, and this tool allows easy extraction and transformation of the data for analysis.
## Features
- **Read PDZ files in version 24 and 25 formats.**
- **Parse and extract important information from the PDZ file into JSON format.**
- **Convert the parsed data to CSV format for further analysis.**
- **Verbose and debug modes to help troubleshoot issues during parsing.**
## Installation
You can install `pdz-tool` via `pip`.
```bash
pip install pdz-tool
```
## Usage
```python
#### 1. Importing and Initializing PDZTool
from pdz_tool import PDZTool
# Initialize a PDZTool object
pdz_tool = PDZTool('path/to/pdz_file.pdz')
#### 2. Parsing a PDZ File
parsed_data = pdz_tool.parse()
#### 3. Accessing Parsed Data as a Dictionary
record_names = pdz_tool.record_names # Record names found on the pdz file
for record_name in record_names:
print(f"Record Name: {record_name}")
print(parsed_data[record_name])
#### 4. Converting Parsed Data to JSON
json_data = pdz_tool.to_json()
print(json_data)
#### 5. Saving Parsed Data to JSON File
pdz_tool.to_json('output.json')
#### 6. Saving Parsed Data to CSV
pdz_tool.to_csv('output.csv')
```
### CLI Usage:
```bash
pdz-tool path/to/pdz_file.pdz
```
see `pdz-tool --help` for more options.
## Demo
Demo folder is included in the project, containing example PDZ files to help you get started.
You can run the demo script to test the functionality of the PDZ-Tool:
```bash
python demo/demo_script.py
```
## Development
### Cloning the Repository
If you wish to modify or extend the tool, clone the repository:
```bash
git clone git@github.com:bducraux/pdz-tool.git
cd pdz-tool
```
### Dependencies
#### Installing Poetry
This project uses Poetry for dependency management. If you don't have Poetry installed, you can install it by running:
```bash
pip install poetry
```
#### Installing Dependencies
To install the dependencies, run:
```bash
poetry install
```
## Contributing
Contributions are welcome! If you find any bugs or have suggestions for new features, feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the LICENSE file for details.
## Contact
For any inquiries or support, please reach out at [bruno.drx@gmail.com](mailto:bruno.drx@gmail.com).
Thank you for using PDZ-Tool! 😊
Raw data
{
"_id": null,
"home_page": "https://github.com/bducraux/pdz-tool",
"name": "pdz-tool",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "pdz, format, transformation",
"author": "Bruno Ducraux",
"author_email": "bruno.drx@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c4/c4/ed4d545d5f0929b4fdeb4f6a3917516c32b74be2dc243302b457712e9cd6/pdz_tool-0.2.0.tar.gz",
"platform": null,
"description": "# PDZ-Tool\n\n**PDZ-Tool** is a Python library for reading PDZ files and converting them into CSV or JSON formats. PDZ files are commonly used to store data from X-ray fluorescence (XRF) instruments, and this tool allows easy extraction and transformation of the data for analysis.\n\n## Features\n\n- **Read PDZ files in version 24 and 25 formats.**\n- **Parse and extract important information from the PDZ file into JSON format.**\n- **Convert the parsed data to CSV format for further analysis.**\n- **Verbose and debug modes to help troubleshoot issues during parsing.**\n\n## Installation\n\nYou can install `pdz-tool` via `pip`.\n\n```bash\npip install pdz-tool\n```\n\n## Usage\n\n```python\n#### 1. Importing and Initializing PDZTool\nfrom pdz_tool import PDZTool\n\n# Initialize a PDZTool object\npdz_tool = PDZTool('path/to/pdz_file.pdz')\n\n#### 2. Parsing a PDZ File\nparsed_data = pdz_tool.parse()\n\n#### 3. Accessing Parsed Data as a Dictionary\nrecord_names = pdz_tool.record_names # Record names found on the pdz file\nfor record_name in record_names:\n print(f\"Record Name: {record_name}\")\n print(parsed_data[record_name])\n \n#### 4. Converting Parsed Data to JSON\njson_data = pdz_tool.to_json()\nprint(json_data)\n\n#### 5. Saving Parsed Data to JSON File\npdz_tool.to_json('output.json')\n\n#### 6. Saving Parsed Data to CSV\npdz_tool.to_csv('output.csv')\n```\n\n### CLI Usage:\n```bash\npdz-tool path/to/pdz_file.pdz\n```\nsee `pdz-tool --help` for more options.\n\n## Demo\n Demo folder is included in the project, containing example PDZ files to help you get started. \n You can run the demo script to test the functionality of the PDZ-Tool:\n\n```bash\npython demo/demo_script.py\n```\n## Development\n### Cloning the Repository\nIf you wish to modify or extend the tool, clone the repository:\n \n```bash\ngit clone git@github.com:bducraux/pdz-tool.git\ncd pdz-tool\n``` \n\n### Dependencies\n#### Installing Poetry\nThis project uses Poetry for dependency management. If you don't have Poetry installed, you can install it by running:\n\n```bash\npip install poetry\n```\n#### Installing Dependencies\nTo install the dependencies, run:\n\n```bash\npoetry install\n```\n\n## Contributing\nContributions are welcome! If you find any bugs or have suggestions for new features, feel free to open an issue or submit a pull request.\n\n## License\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n## Contact\nFor any inquiries or support, please reach out at [bruno.drx@gmail.com](mailto:bruno.drx@gmail.com).\n\nThank you for using PDZ-Tool! \ud83d\ude0a",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tool for reading and transforming PDZ 24 and PDZ 25 formats",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/bducraux/pdz-tool",
"Repository": "https://github.com/bducraux/pdz-tool"
},
"split_keywords": [
"pdz",
" format",
" transformation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57a70f8c4a1d10778eb45c08a538874e62e92bdea5ac255d01c35524e58880bd",
"md5": "d9d94ce3c27a6c81bea9e683e90bbdfc",
"sha256": "73f478a9fe6b6344650b0ebe1cb8f8509d77e95503453c3a8087d8adc6217236"
},
"downloads": -1,
"filename": "pdz_tool-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d9d94ce3c27a6c81bea9e683e90bbdfc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 14596,
"upload_time": "2024-10-04T00:11:10",
"upload_time_iso_8601": "2024-10-04T00:11:10.636772Z",
"url": "https://files.pythonhosted.org/packages/57/a7/0f8c4a1d10778eb45c08a538874e62e92bdea5ac255d01c35524e58880bd/pdz_tool-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4c4ed4d545d5f0929b4fdeb4f6a3917516c32b74be2dc243302b457712e9cd6",
"md5": "9865f81258ee142f3be31b43711bcd9b",
"sha256": "cfb27784c1b96c03648248b04eb453ed56a3ffcbb2b8e9c9ae49a82ffc477605"
},
"downloads": -1,
"filename": "pdz_tool-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "9865f81258ee142f3be31b43711bcd9b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 12493,
"upload_time": "2024-10-04T00:11:12",
"upload_time_iso_8601": "2024-10-04T00:11:12.480414Z",
"url": "https://files.pythonhosted.org/packages/c4/c4/ed4d545d5f0929b4fdeb4f6a3917516c32b74be2dc243302b457712e9cd6/pdz_tool-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 00:11:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bducraux",
"github_project": "pdz-tool",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pdz-tool"
}
JSON
