pybcsv 1.0.1__tar.gz

pybcsv-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tobias Weber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pybcsv-1.0.1/MANIFEST.in

@@ -0,0 +1,14 @@
+include README.md
+include LICENSE
+include pybcsv/py.typed
+recursive-include include *.h
+recursive-include include *.hpp
+recursive-include include *.c
+recursive-include pybcsv *.h
+recursive-include pybcsv *.hpp
+recursive-include pybcsv *.cpp
+recursive-exclude tests *
+recursive-exclude examples *
+global-exclude *.pyc
+global-exclude __pycache__
+global-exclude .DS_Store

pybcsv-1.0.1/PKG-INFO

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: pybcsv
+Version: 1.0.1
+Summary: High-performance Python bindings for the BCSV (Binary CSV) library with pandas integration
+Author: Tobias Weber
+Author-email: Tobias Weber <weber.tobias.md@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/weber-tobias/bcsv
+Project-URL: Documentation, https://github.com/weber-tobias/bcsv#readme
+Project-URL: Repository, https://github.com/weber-tobias/bcsv
+Project-URL: Bug Tracker, https://github.com/weber-tobias/bcsv/issues
+Project-URL: Source Code, https://github.com/weber-tobias/bcsv
+Keywords: csv,binary,data-science,compression,performance,pandas,numpy,big-data,data-processing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Archiving :: Compression
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.19.0
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.0.0; extra == "pandas"
+Provides-Extra: test
+Requires-Dist: pytest>=6.0.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# PyBCSV - Python Bindings for BCSV Library
+
+PyBCSV provides Python bindings for the high-performance BCSV (Binary CSV) library, enabling efficient binary CSV file handling with pandas integration.
+
+## Features
+
+- **High Performance**: Binary format with optional LZ4 compression
+- **Pandas Integration**: Direct DataFrame read/write support
+- **Type Safety**: Preserves column types and data integrity
+- **Cross-platform**: Works on Linux, macOS, and Windows
+- **Memory Efficient**: Streaming support for large datasets
+
+## Installation
+
+The Python wrapper has been successfully built and installed. To use it:
+
+```bash
+cd /home/tobias/bcsv/python
+source venv/bin/activate
+pip install .
+```
+
+## Basic Usage
+
+### Core BCSV Operations
+
+```python
+import pybcsv
+
+# Create a layout
+layout = pybcsv.Layout()
+layout.add_column("id", pybcsv.INT32)
+layout.add_column("name", pybcsv.STRING) 
+layout.add_column("value", pybcsv.DOUBLE)
+
+# Write data
+writer = pybcsv.Writer(layout)
+writer.open("data.bcsv")
+writer.write_row([1, "Alice", 123.45])
+writer.write_row([2, "Bob", 678.90])
+writer.close()
+
+# Read data
+reader = pybcsv.Reader()
+reader.open("data.bcsv")
+all_rows = reader.read_all()
+reader.close()
+
+print(all_rows)
+# Output: [[1, 'Alice', 123.45], [2, 'Bob', 678.9]]
+```
+
+### Pandas Integration
+
+```python
+import pybcsv
+import pandas as pd
+
+# Create a DataFrame
+df = pd.DataFrame({
+    'id': [1, 2, 3],
+    'name': ['Alice', 'Bob', 'Charlie'],
+    'value': [123.45, 678.90, 111.22]
+})
+
+# Write DataFrame to BCSV
+pybcsv.write_dataframe(df, "data.bcsv")
+
+# Read back as DataFrame
+df_read = pybcsv.read_dataframe("data.bcsv")
+print(df_read.equals(df))  # True
+```
+
+### CSV Conversion
+
+```python
+import pybcsv
+
+# Convert CSV to BCSV
+pybcsv.from_csv("input.csv", "output.bcsv")
+
+# Convert BCSV to CSV
+pybcsv.to_csv("output.bcsv", "output.csv")
+```
+
+## Available Types
+
+- `pybcsv.BOOL` - Boolean values
+- `pybcsv.INT8` / `pybcsv.UINT8` - 8-bit integers
+- `pybcsv.INT16` / `pybcsv.UINT16` - 16-bit integers  
+- `pybcsv.INT32` / `pybcsv.UINT32` - 32-bit integers
+- `pybcsv.INT64` / `pybcsv.UINT64` - 64-bit integers
+- `pybcsv.FLOAT` - 32-bit floating point
+- `pybcsv.DOUBLE` - 64-bit floating point
+- `pybcsv.STRING` - Variable-length strings
+
+## API Reference
+
+### Layout Class
+
+```python
+layout = pybcsv.Layout()
+layout.add_column(name: str, column_type: ColumnType)
+layout.column_count() -> int
+layout.column_name(index: int) -> str
+layout.column_type(index: int) -> ColumnType
+layout.has_column(name: str) -> bool
+layout.column_index(name: str) -> int
+```
+
+### Writer Class
+
+```python
+writer = pybcsv.Writer(layout: Layout)
+writer.open(filename: str) -> bool
+writer.write_row(values: list) -> None
+writer.flush() -> None
+writer.close() -> None
+writer.is_open() -> bool
+```
+
+### Reader Class
+
+```python
+reader = pybcsv.Reader()
+reader.open(filename: str) -> bool
+reader.read_next() -> bool
+reader.read_all() -> list[list]
+reader.close() -> None
+reader.is_open() -> bool
+reader.layout() -> Layout
+```
+
+### Utility Functions
+
+```python
+# Pandas integration
+pybcsv.write_dataframe(df: pd.DataFrame, filename: str, compression: bool = True)
+pybcsv.read_dataframe(filename: str) -> pd.DataFrame
+
+# CSV conversion
+pybcsv.from_csv(csv_filename: str, bcsv_filename: str, compression: bool = True)
+pybcsv.to_csv(bcsv_filename: str, csv_filename: str)
+
+# Type utilities
+pybcsv.type_to_string(column_type: ColumnType) -> str
+```
+
+## Performance Benefits
+
+The binary format provides significant advantages:
+
+1. **Faster I/O**: Binary format is faster to read/write than text CSV
+2. **Type Safety**: Preserves exact data types without parsing
+3. **Compression**: Optional LZ4 compression reduces file size
+4. **Memory Efficiency**: Streaming support for large datasets
+
+## Testing
+
+Run the included test scripts to verify functionality:
+
+```bash
+python test_basic.py      # Basic BCSV operations
+python test_pandas.py     # Pandas integration tests
+```
+
+## File Structure
+
+```text
+python/
+├── pybcsv/
+│   ├── __init__.py           # Main module interface
+│   ├── __version__.py        # Version information
+│   ├── bindings.cpp          # C++ pybind11 bindings
+│   └── pandas_utils.py       # Pandas integration utilities
+├── examples/
+│   ├── basic_example.py      # Basic usage examples
+│   └── pandas_example.py     # Pandas integration examples
+├── tests/
+│   ├── test_basic.py         # Basic functionality tests
+│   └── test_pandas.py        # Pandas integration tests
+├── setup.py                  # Package build configuration
+├── pyproject.toml           # Modern Python packaging config
+└── README.md                # This documentation
+```
+
+## Compatibility
+
+- **Python**: 3.7+ (tested with 3.12)
+- **Dependencies**:
+  - numpy >= 1.19.0 (required)
+  - pandas >= 1.3.0 (optional, for DataFrame integration)
+- **Platforms**: Linux, macOS, Windows
+- **Compilers**: GCC 7+, Clang 8+, MSVC 2019+
+
+## Performance Results
+
+Based on testing with sample data:
+
+- **DataFrame I/O**: Perfect data fidelity with type preservation
+- **File Size**: Efficient binary encoding (varies by data and compression)
+- **Speed**: Significantly faster than CSV for repeated I/O operations
+- **Memory**: Streaming support for large datasets
+
+The Python wrapper successfully bridges the high-performance C++ BCSV library with Python's data science ecosystem, providing both convenience and performance for data processing workflows.
+
+## License
+
+MIT License
+
+Copyright (c) 2025 Tobias Weber <weber.tobias.md@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+See the [LICENSE](LICENSE) file for full details.

pybcsv-1.0.1/README.md

@@ -0,0 +1,231 @@
+# PyBCSV - Python Bindings for BCSV Library
+
+PyBCSV provides Python bindings for the high-performance BCSV (Binary CSV) library, enabling efficient binary CSV file handling with pandas integration.
+
+## Features
+
+- **High Performance**: Binary format with optional LZ4 compression
+- **Pandas Integration**: Direct DataFrame read/write support
+- **Type Safety**: Preserves column types and data integrity
+- **Cross-platform**: Works on Linux, macOS, and Windows
+- **Memory Efficient**: Streaming support for large datasets
+
+## Installation
+
+The Python wrapper has been successfully built and installed. To use it:
+
+```bash
+cd /home/tobias/bcsv/python
+source venv/bin/activate
+pip install .
+```
+
+## Basic Usage
+
+### Core BCSV Operations
+
+```python
+import pybcsv
+
+# Create a layout
+layout = pybcsv.Layout()
+layout.add_column("id", pybcsv.INT32)
+layout.add_column("name", pybcsv.STRING) 
+layout.add_column("value", pybcsv.DOUBLE)
+
+# Write data
+writer = pybcsv.Writer(layout)
+writer.open("data.bcsv")
+writer.write_row([1, "Alice", 123.45])
+writer.write_row([2, "Bob", 678.90])
+writer.close()
+
+# Read data
+reader = pybcsv.Reader()
+reader.open("data.bcsv")
+all_rows = reader.read_all()
+reader.close()
+
+print(all_rows)
+# Output: [[1, 'Alice', 123.45], [2, 'Bob', 678.9]]
+```
+
+### Pandas Integration
+
+```python
+import pybcsv
+import pandas as pd
+
+# Create a DataFrame
+df = pd.DataFrame({
+    'id': [1, 2, 3],
+    'name': ['Alice', 'Bob', 'Charlie'],
+    'value': [123.45, 678.90, 111.22]
+})
+
+# Write DataFrame to BCSV
+pybcsv.write_dataframe(df, "data.bcsv")
+
+# Read back as DataFrame
+df_read = pybcsv.read_dataframe("data.bcsv")
+print(df_read.equals(df))  # True
+```
+
+### CSV Conversion
+
+```python
+import pybcsv
+
+# Convert CSV to BCSV
+pybcsv.from_csv("input.csv", "output.bcsv")
+
+# Convert BCSV to CSV
+pybcsv.to_csv("output.bcsv", "output.csv")
+```
+
+## Available Types
+
+- `pybcsv.BOOL` - Boolean values
+- `pybcsv.INT8` / `pybcsv.UINT8` - 8-bit integers
+- `pybcsv.INT16` / `pybcsv.UINT16` - 16-bit integers  
+- `pybcsv.INT32` / `pybcsv.UINT32` - 32-bit integers
+- `pybcsv.INT64` / `pybcsv.UINT64` - 64-bit integers
+- `pybcsv.FLOAT` - 32-bit floating point
+- `pybcsv.DOUBLE` - 64-bit floating point
+- `pybcsv.STRING` - Variable-length strings
+
+## API Reference
+
+### Layout Class
+
+```python
+layout = pybcsv.Layout()
+layout.add_column(name: str, column_type: ColumnType)
+layout.column_count() -> int
+layout.column_name(index: int) -> str
+layout.column_type(index: int) -> ColumnType
+layout.has_column(name: str) -> bool
+layout.column_index(name: str) -> int
+```
+
+### Writer Class
+
+```python
+writer = pybcsv.Writer(layout: Layout)
+writer.open(filename: str) -> bool
+writer.write_row(values: list) -> None
+writer.flush() -> None
+writer.close() -> None
+writer.is_open() -> bool
+```
+
+### Reader Class
+
+```python
+reader = pybcsv.Reader()
+reader.open(filename: str) -> bool
+reader.read_next() -> bool
+reader.read_all() -> list[list]
+reader.close() -> None
+reader.is_open() -> bool
+reader.layout() -> Layout
+```
+
+### Utility Functions
+
+```python
+# Pandas integration
+pybcsv.write_dataframe(df: pd.DataFrame, filename: str, compression: bool = True)
+pybcsv.read_dataframe(filename: str) -> pd.DataFrame
+
+# CSV conversion
+pybcsv.from_csv(csv_filename: str, bcsv_filename: str, compression: bool = True)
+pybcsv.to_csv(bcsv_filename: str, csv_filename: str)
+
+# Type utilities
+pybcsv.type_to_string(column_type: ColumnType) -> str
+```
+
+## Performance Benefits
+
+The binary format provides significant advantages:
+
+1. **Faster I/O**: Binary format is faster to read/write than text CSV
+2. **Type Safety**: Preserves exact data types without parsing
+3. **Compression**: Optional LZ4 compression reduces file size
+4. **Memory Efficiency**: Streaming support for large datasets
+
+## Testing
+
+Run the included test scripts to verify functionality:
+
+```bash
+python test_basic.py      # Basic BCSV operations
+python test_pandas.py     # Pandas integration tests
+```
+
+## File Structure
+
+```text
+python/
+├── pybcsv/
+│   ├── __init__.py           # Main module interface
+│   ├── __version__.py        # Version information
+│   ├── bindings.cpp          # C++ pybind11 bindings
+│   └── pandas_utils.py       # Pandas integration utilities
+├── examples/
+│   ├── basic_example.py      # Basic usage examples
+│   └── pandas_example.py     # Pandas integration examples
+├── tests/
+│   ├── test_basic.py         # Basic functionality tests
+│   └── test_pandas.py        # Pandas integration tests
+├── setup.py                  # Package build configuration
+├── pyproject.toml           # Modern Python packaging config
+└── README.md                # This documentation
+```
+
+## Compatibility
+
+- **Python**: 3.7+ (tested with 3.12)
+- **Dependencies**:
+  - numpy >= 1.19.0 (required)
+  - pandas >= 1.3.0 (optional, for DataFrame integration)
+- **Platforms**: Linux, macOS, Windows
+- **Compilers**: GCC 7+, Clang 8+, MSVC 2019+
+
+## Performance Results
+
+Based on testing with sample data:
+
+- **DataFrame I/O**: Perfect data fidelity with type preservation
+- **File Size**: Efficient binary encoding (varies by data and compression)
+- **Speed**: Significantly faster than CSV for repeated I/O operations
+- **Memory**: Streaming support for large datasets
+
+The Python wrapper successfully bridges the high-performance C++ BCSV library with Python's data science ecosystem, providing both convenience and performance for data processing workflows.
+
+## License
+
+MIT License
+
+Copyright (c) 2025 Tobias Weber <weber.tobias.md@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+See the [LICENSE](LICENSE) file for full details.

pybcsv-1.0.1/include/bcsv/bcsv.h

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2025 Tobias Weber <weber.tobias.md@gmail.com>
+ * 
+ * This file is part of the BCSV library.
+ * 
+ * Licensed under the MIT License. See LICENSE file in the project root 
+ * for full license information.
+ */
+
+#pragma once
+
+/**
+ * @file bcsv.h
+ * @brief Binary CSV (BCSV) Library - Main Header with Declarations
+ * 
+ * A C++17 header-only library for reading and writing binary CSV files
+ * with type safety, compression support, and efficient I/O operations.
+ * 
+ * This header includes all BCSV component declarations:
+ * - FileHeader: Binary file header management
+ * - ColumnLayout: Column definitions and metadata
+ * - Row: Individual data rows
+ * - Packet: Data packet abstraction
+ * - Reader: Template-based file reading
+ * - Writer: Template-based file writing
+ */
+
+#include <iostream>
+#include <string>
+
+// Core definitions first
+#include "definitions.h"
+
+// Core component declarations
+#include "file_header.h"
+#include "layout.h"
+#include "packet_header.h"
+#include "reader.h"
+#include "row.h"
+#include "writer.h"
+
+// Include implementations
+#include "bcsv.hpp"
+#include "file_header.hpp"
+#include "layout.hpp"
+#include "packet_header.hpp"
+#include "reader.hpp"
+#include "row.hpp"
+#include "writer.hpp"

pybcsv-1.0.1/include/bcsv/bcsv.hpp

@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2025 Tobias Weber <weber.tobias.md@gmail.com>
+ * 
+ * This file is part of the BCSV library.
+ * 
+ * Licensed under the MIT License. See LICENSE file in the project root 
+ * for full license information.
+ */
+
+#pragma once
+
+/**
+ * @file bcsv.hpp
+ * @brief Binary CSV (BCSV) Library - Shared implementations and utilities
+ * 
+ * This file contains implementations that require multiple headers to be included first.
+ */
+
+#include "file_header.h"
+#include "layout.h"
+
+namespace bcsv {
+    // Type traits to check if StreamType supports file operations
+    template<typename T>
+    struct is_fstream {
+        static constexpr bool value = std::is_same_v<T, std::fstream> || std::is_base_of_v<std::fstream, T>;
+    };
+    template<typename T>
+    struct is_ifstream {
+        static constexpr bool value = std::is_same_v<T, std::ifstream> || std::is_base_of_v<std::ifstream, T> || std::is_same_v<T, std::fstream> || std::is_base_of_v<std::fstream, T>;
+    };
+
+    template<typename T>
+    struct is_ofstream {
+        static constexpr bool value = std::is_same_v<T, std::ofstream> || std::is_base_of_v<std::ofstream, T> || std::is_same_v<T, std::fstream> || std::is_base_of_v<std::fstream, T>;
+    };
+
+    template<typename T>
+    struct has_open_method {
+        template<typename U>
+        static auto test(int) -> decltype(std::declval<U>().open(std::string{}), std::true_type{});
+        template<typename>
+        static std::false_type test(...);
+        using type = decltype(test<T>(0));
+        static constexpr bool value = type::value;
+    };
+
+    template<typename T>
+    struct has_close_method {
+        template<typename U>
+        static auto test(int) -> decltype(std::declval<U>().close(), std::true_type{});
+        template<typename>
+        static std::false_type test(...);
+        using type = decltype(test<T>(0));
+        static constexpr bool value = type::value;
+    };
+
+    template<typename T>
+    struct has_is_open_method {
+        template<typename U>
+        static auto test(int) -> decltype(std::declval<U>().is_open(), std::true_type{});
+        template<typename>
+        static std::false_type test(...);
+        using type = decltype(test<T>(0));
+        static constexpr bool value = type::value;
+    };
+
+} // namespace bcsv