Skip to content

Commit

Permalink
v0.0.5
Browse files Browse the repository at this point in the history
Updated the current state of the project.
  • Loading branch information
LzLang authored May 13, 2023
1 parent 873464d commit 8cda52e
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,42 @@
# Zendro-Converter
A script to convert data from BrAPI to Zendro-API
ToDo:
- Testing with different/other files
- Checking if output is correct or if properties are missing
- Writing a function, that goes through the file system/directories and read the JSON-files automtically
- Setting output to same filename as input
- Commenting whole code and writing a documentation
- Further testing

13.05.2023: Creating a git-repository
Goal: Better version control, traceability and accessibility
Uploaded every version until now (current version: v0.0.5)

12.05.2023: Script v0.0.5 - Cleaning up the script
Goal: Writing a class just fot the functions (modularization)
--> logMSG(msg): Write a msg with date and time to a log
--> readJSON(path, fname): Read in a JSON-file
--> writeJSON(path, fname, propData): Write data from properties to a JSON-file
--> getPropType(types): Return compatible/allowed types
--> getZendroType(types): Convert and return the Zendro types
--> getPropData(data): Return a dictionary with only properties, that have a Zendro compatible type
Observation: Only properties with compatible types are exported to the JSON-file

11.05.2023: Script v0.0.4 - Extract only allowed data types
Goal: Extract only properties with data types that are compatible with Zendro
--> Using numpy to check if data types are compatible
Observation: Some properties are extracted without their data type

11.05.2023: Script v0.0.3 - Extracting further informations
Goal: Extract and write a file with the description and types of every property
Observation: types are saved as array, further extraction needed

11.05.2023: Script v0.0.2 - Extracting only the "properties"
Goal: Extracting only the necessary informations (in this case the properties)
--> Creating a test-file to test if extraction is working
Observation: Extraction is working, input is stored as dictionary

11.05.2023: Script v0.0.1 - First try to use a JSON-file as input
Goal: Understanding the json module and how it's reading files
--> Creating a test-file to write the input
Observation: json module is usefule and will be used for this project

0 comments on commit 8cda52e

Please sign in to comment.