Adding files and editing readme aand project.toml file

Author: Bright-yaw

Project.toml

@@ -1,7 +1,7 @@
 name = "ReadDBC"
 uuid = "79d50320-df92-4ae6-9b90-d461b5bc1756"
 authors = ["Bright-yaw <[email protected]> and contributors"]
-version = "1.0.0-DEV"
+version = "1.0.0"
 
 [deps]
 DBFTables = "75c7ada1-017a-5fb6-b8c7-2125ff2d6c93"
@@ -12,6 +12,8 @@ Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 
 [compat]
 julia = "1.10.4"
+DBFTables = "1.2.6"
+DataFrames = "1.6.1"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -4,3 +4,68 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://lego-yaw.github.io/ReadDBC.jl/dev/)
 [![Build Status](https://github.com/lego-yaw/ReadDBC.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/lego-yaw/ReadDBC.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/lego-yaw/ReadDBC.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/lego-yaw/ReadDBC.jl)
+
+
+
+### ReadDBC.jl
++ A simple package for converting *.dbc* (compressed DBC) files from Datasus into *.dbf* (DBF) and *data frames* tables. 
+
++ DATASUS plays a critical role in ensuring the efficient operation of Brazil's public health system. DATASUS is the name of the Departement of informatics of Brazil's health system (Sistema Unico de Saúde-SUS). They are responsible for maintaining and publishing Brazilian public health data. Aside this, the Brazilian National Agency for supplementary Health data (ANS), also use the same file format for storing public health data. 
+
++ *Please note* that, this package only handles *.dbc*  format used by DATASUS and is not in any way related to handling Microsoft Foxpro or CANdb DBC files.
+
+## Installation
++ Package can be installed like any other julia package  
+
+```Julia-repl
+>>> ]
+>>> add ReadDBC
+```
+or
+
+```
+>>> using Pkg
+>>> Pkg.add("ReadDBC")
+```
+# Usage 
++ ReadDBC is simple to use 
+
+```
+# converting dbc to dbf format
+>>> using ReadDBC
+>>> dbctodbc("path/to/file.dbc, path/to/file.dbf) # input file is .dbc file and output file is .dbf
+
+# converting dbc into dataframe Table
+>>> using readdbc
+>>> df = dbcTable("path/to/file.dbc)" # input file is .dbc file and output file is in table format
+>>> head(df) 
+
+# Example
+>>> using Download, using ReadDBC
+>>> download("ftp://ftp.datasus.gov.br/dissemin/publicos/SIASUS/200801_/Dados/ABOAC1909.dbc", "ABOAC1909.dbc") # this link downlaods the ABOAC1909.dbc file from Datasus database.
+
+# run fucntion
+>>> df = dbcTable("ABOAC1909.dbc") ## read into dataframe Table
+>>> display(df) 
+
+or
+
+>>> using ReadDBC
+>>> dbctodbc("ABOAC1909.dbc", "ABOAC1909.dbf") # conversion into DBF format
+
+```
+
+# Format description references
+
+* https://en.wikipedia.org/wiki/.dbf
+* https://www.clicketyclick.dk/databases/xbase/format/dbf.html
+* http://www.independent-software.com/dbase-dbf-dbt-file-format.html
+
+# Contact information
++ if you have any questions or suggestions, feel free to contact at [email protected]
+
+# Citation
++ This project is based on the work of https://github.com/madler/zlib/tree/master/contrib/blast and https:// github.com/eaglebh/blast-dbf and the R version developed by danicat(https://github.com/danicat/read.dbc). 
+Also this package wouldn't have been possible without DBFTable (https://github.com/JuliaData/DBFTables.jl)
+
++ Neither this project, nor its author, is related in any way to the Brazilian government.

src/ABOAC1909.dbc

@@ -1,5 +1,59 @@
 module ReadDBC
 
-# Write your package code here.
+# Export functions 
+export dbcTable, dbctodbf
 
+# Importing packages 
+using DBFTables
+using DataFrames
+using Logging
+using Libdl
+
+
+# Defining function dbctodbf
+function dbctodbf(input_file::String, output_file::String)
+    # Load the shared library
+    lib = dlopen("src/libdbc2dbf.dll")
+    
+    # Ensure the library is properly loaded
+    if lib === C_NULL
+        error("Failed to load the library.")
+    end
+
+    # Create a pointer to the C function in the library
+    func = dlsym(lib, :dbc2dbf)
+    
+    # Ensure the function pointer is valid
+    if func === C_NULL
+        dlclose(lib)
+        error("Failed to find the function dbc2dbf in the library.")
+    end
+
+    # Call the C function directly with string parameters
+    result = ccall(func, Cvoid, (Cstring, Cstring), input_file, output_file)
+
+    # Close the library after the function call
+    dlclose(lib)
+    
+    return result
+end
+
+# Defining function readdbc
+function dbcTable(input_file::String)
+    output_file = replace(input_file, ".dbc" => ".dbf")
+    try
+        # Convert the DBC file to a DBF file
+        dbctodbf(input_file, output_file)
+        
+        # Read the DBF file into a DataFrame
+        df = DBFTables.Table(output_file)
+        return DataFrame(df)
+        
+    catch e
+        @error "Failed to convert or read DBC file: $input_file"
+        @error "$e"
+        return nothing
+    end
 end
+
+end  # module readdbc