documentation

Author: GregHanson

src/convert.rs

@@ -1,3 +1,16 @@
+//! # CSV2RDF Converter Library
+//!
+//! This library provides functionality for converting CSV data into RDF format.
+//! It uses `csv` for XML parsing and `oxrdf` to build and manage RDF graphs.
+//!
+//! ## Overview
+//! - Converts CSV data structures into RDF triples, generating a graph representation.
+//!
+//! ## Features
+//! - Converts nested CSV Objects into RDF triples.
+//! - Allows specifying a custom RDF namespace for generated predicates and objects.
+//! - Outputs the RDF data to a specified file.
+
 use std::collections::HashMap;
 
 use crate::writer::RdfWriter;
@@ -9,6 +22,30 @@ use uuid::Uuid;
 
 const C2R: &'static str = "https://decisym.ai/csv2rdf/model#";
 
+/// Converts CSV data to RDF format.
+///
+/// This function reads CSV data from the specified file, processes it into RDF triples,
+/// and outputs the RDF graph. Users can specify a namespace to use for RDF predicates and
+/// an output file for saving the generated RDF data.
+///
+/// # Arguments
+/// - `files`: Path to the CSV files.
+/// - `namespace`: Optional custom namespace for RDF predicates.
+/// - `output`: use RdfWriter trait to add generated triples to desired format (File or Graph)
+///
+/// # Example
+/// ```rust
+/// use csv2rdf::convert::parse_csv;
+/// use csv2rdf::writer;
+/// use oxrdf::Graph;
+///
+/// let mut w = writer::FileWriter::to_file("output.nt".to_string()).unwrap();
+/// parse_csv(vec!["data.csv".to_string()], &mut w, "https://decisym.ai/csv2rdf/data");
+///
+/// let mut g = Graph::new();
+/// let mut w = writer::GraphWriter::new(&mut g);
+/// parse_csv(vec!["data.csv".to_string()], &mut w, "https://decisym.ai/csv2rdf/data");
+/// ```
 pub fn parse_csv(
     files: Vec<String>,
     output: &mut dyn RdfWriter,

src/main.rs

@@ -1,34 +1,34 @@
-//! # XML2RDF Converter
+//! # CSV2RDF Converter
 //!
-//! This is a Rust-based tool that converts XML data into RDF format. It uses the `xml-rs` crate
-//! for XML parsing and the `oxrdf` crate to construct RDF triples and graphs.
+//! This is a Rust-based tool that converts CSV data into RDF format. It uses the `csv` crate
+//! for CSV parsing and the `oxrdf` crate to construct RDF triples and graphs.
 //!
 //! ## Features
-//! - Parses XML input and converts it to RDF triples
+//! - Parses CSV input and converts it to RDF triples
 //! - Supports specifying a custom namespace for generated RDF nodes
 //! - Outputs RDF data to a specified file, oxrdf::Graph or stdout
 //!
 //! ## Usage
-//! Run the XML2RDF converter from the command line. For detailed usage information, run:
+//! Run the CSV2RDF converter from the command line. For detailed usage information, run:
 //! ```
-//! xml2rdf --help
+//! csv2rdf --help
 //! ```
 //!
 //! ## Example
-//! To convert a XML file to RDF format with a specified namespace and output file:
+//! To convert a CSV file to RDF format with a specified namespace and output file:
 //! ```
-//! xml2rdf convert --namespace http://example.com/ns# --xml data.xml --output-file output.nt
+//! csv2rdf convert --namespace http://example.com/ns# --input data.xml --output output.nt
 //! ```
-//! This will take `data.xml`, apply the specified namespace, and save the RDF output in `output.nt`.
+//! This will take `data.csv`, apply the specified namespace, and save the RDF output in `output.nt`.
 
 use clap::{Parser, Subcommand};
 use csv2rdf::*;
 
-/// Command-line interface for XML2RDF Converter
+/// Command-line interface for CSV2RDF Converter
 ///
-/// This struct defines the command-line interface (CLI) for interacting with the XML2RDF converter.
+/// This struct defines the command-line interface (CLI) for interacting with the CSV2RDF converter.
 #[derive(Parser)]
-#[command(version, about = "Converts XML data into RDF format.")]
+#[command(version, about = "Converts CSV data into RDF format.")]
 struct Cli {
     /// CLI command selection
     #[command(subcommand)]
@@ -37,12 +37,12 @@ struct Cli {
 
 /// Supported Commands
 ///
-/// Contains the available commands for the XML2RDF converter.
+/// Contains the available commands for the CSV2RDF converter.
 #[derive(Subcommand)]
 enum Commands {
-    /// Convert XML to RDF format.
+    /// Convert CSV to RDF format.
     ///
-    /// The `convert` command parses a XML file, converts it to RDF triples using `xml-rs` for parsing
+    /// The `convert` command parses a CSV file, converts it to RDF triples using `csv` for parsing
     /// and `oxrdf` to construct the graph, and saves the output.
     Convert {
         /// Namespace for RDF graph generation.
@@ -51,9 +51,9 @@ enum Commands {
         #[arg(short, long, default_value = "https://decisym.ai/csv2rdf/data")]
         namespace: String,
 
-        /// Path to input XML file(s).
+        /// Path to input CSV file(s).
         ///
-        /// Provide the path to one or more XML files that will be parsed and converted.
+        /// Provide the path to one or more CSV files that will be parsed and converted.
         #[arg(short, long, num_args = 1..)]
         input: Vec<String>,