Main dev

README.md

@@ -1,105 +1,102 @@
-## Post XML files to a server port
+# XML_postToREST
+
+XML_postToREST is a Python program for posting DOIs metadata in XML format to DataCite REST API
 
 <br/>
 
-### Step 1
+## Getting Started
+
+`xml_post_parser.py` is the program you will call to do the task
+
+It will call two python classes:
+* `class_xml_encode.py`: encode XML files to JSON envelope
+
+* `class_json_post.py`: post JSON envelopes to server port
+
 
 <br/>
 
-Check the `"xml_post_parser_config.json"` file for the configurations of the codes
+## Usage
+
+Check the configuration file `xml_post_parser_config.json` and start configure your program:
 
 <br/>
 
+
 **Important fields**
 
-`"server_port"`:
+```
+"server_port":
 
 the location you want to post your files to
 
-`"bearer_auth_key"`:
+"bearer_auth_key":
 
 your Bearer Auth key to access DataCite REST API
 
-`"prefix"`:
+"prefix":
 
 namespace of the DOIs you are using
 
-`"schema_url"`:
+"schema_url":
 
 schema for the DOIs
+```
 
-<br/>
 
 **Folder names**
 
-`"xml_folder"`:
+```
+"xml_folder":
 
 the directory for your input XML files
 
-`"json_folder"`:
+"json_folder":
 
 the directory for your JSON envelopes to be stored at
 
-`"processed_xml_folder"`:
+"processed_xml_folder":
 
 the directory for your processed XML files
 
-`"posted_json_folder"`:
+"posted_json_folder":
 
 the directory for your successfully posted JSON envelopes
 
-`"post_failed_folder"`:
+"post_failed_folder":
 
 the directory for your JSON envelopes that failed to post
 
+```
 <br/>
+----------------------------------------
 
-### Step 2
-
-<br/>
-
-From the config file, use the value of `"xml_folder"` as the name to create a folder in the same directory
+Then from the config file, use the value of `"xml_folder"` as the name to create a folder in the same directory
 
 Store your xml files to be posted to the folder
 
 <br/>
 
-### Step 3
-
-<br/>
-
-Run the python script
+Last, run `xml_post_parser.py`
 
-```python
+``` python
 python xml_post_parser.py
 ```
 
-The XML files will now begin to be encoded into JSON files and then posted to the server port
+XML files will begin to be encoded into JSON files and then posted to the server port
 
 **Successfully posted** files will be stored at `"posted_json_folder"`
 
 **Failed files** will be stored at `"post_failed_folder"`
 
 <br/>
 
-## Additional files
+## Additional file for testing
 
-<br/>
-
-`clear_folders.py`:
+`tests/test_server.py`:
 
-empty all folders after posting (except `"xml_src"`)
-
-<br/>
-
-`test_server.py`:
-
-construct a dummy server using port 5000 in localhost
-
-you can view the posted json files on http://localhost:5000/data
-
-run `test_server.py` in one terminal and `xml_post_parser.py` in another
+construct a dummy server at http://localhost:5000
 
+you can post data to http://localhost:5000 and view the posted data on http://localhost:5000/data
 
 ***Remember to change "server_port" in the config file to http://localhost:5000/***
-

xml_post_parser.py

@@ -1,5 +1,5 @@
-import xml_encode
-import json_post
+import class_xml_encode as xml_encode
+import class_json_post as json_post
 from os import listdir
 from os.path import isfile, join
 import os