Welcome to BuffSAF-Demo

🚧BuffSAF🚧 is a python-based Simple Archive Format compiler meant to create bulk upload files for a D-Space Repository.

The Demo version is a simplified version of the script to make running the script easier for a novice.

Also, please view BuffSAF-scriptbase for the early scripts used in the development of this tool.

Contents of this repository

• LICENSE : MIT License information
• README.md : The README that you are currently reading.
• buffalo-grazing-in-meadow.jpeg : One of the example images for the example metadata.csv.
• buffsaf-demo.html : This is the one file needed to run the unstable version without a python environment.
• buffsaf-demo.py : This is the one file needed to run this program in a python environment.
• 🚧 Manual : This is the additional documentation on how to install and use the script. 🚧
• metadata.csv : The example metadata.csv.
• mother-and-child.jpeg : One of the example images for the example metadata.csv.

Supported metadata

This script currently only supports the following metadata csv headers:

• file.name : This is the name of the file.
• file.description : This is a description of the file, found in the "Bundle" section of D-space.
• dc.title : This is the Dublin Core tag for the title.
• dc.type : This is the Dublin Core tag for document type.
• dc.publisher : This is te Dublin Core tag for publisher.
• dc.language.iso : This is the Dublin Core tag for the ISO language.
• dc.description.abstract : This is the Dublin Core tag for the item description.
• dc.date.issued : This is the Dublin Core tag for the date issued, and must be in YYYY-MM-DD format.
• dc.subject : This is the Dublin Core tag for the subject.

💡 Tip: dc.subject currently allows you to input multiple tags, each separated by double pipe (||).

How to run BuffSAF-Demo

HTML version - UNSTABLE

The HTML version of BuffSAF Demo is intended for use in justifications of getting a Python environment installed. With care, I've gotten it stable up to batches of 375 mb.

⚠️ Warning: Please ensure you only click on the "Compile" button once, as it will hang with no visibile indication that it is processing the file in the html version.

This version uses pyodide and stlite to run fully in a client-side browser.

To run this version:

1. Click on BuffSAF-Demo.html
2. Click on the download icon in the top right corner.
3. Double click the .html file to run the program.
4. 🚧 See additional documentation for instructions on how to use the program. 🚧

Python Version

This is the fully functional, stable version currently in production use at West Texas A&M University.

There is a version with more features available at BuffSAF, however that version is still in development and has a much more complex installation process and less documentation.

To run this version:

1. Click on BuffSAF-Demo.py
2. Click on the download icon in the top right corner.

⚠️ Warning: This version of the script will delete any folder titled "temporary" in the same location as the .py file. Putting the file in its own folder is recommended.

3. Install a python environment. (I recommend Anaconda)
4. Open python prompt.
5. Install pandas using the following prompt:
   pip install pandas
6. Install streamlit using the following prompt:
   pip install streamlit
7. Navigate to the folder containing the .py file.
8. Run the script using the following prompt:
   streamlit run buffsaf-demo.py
9. 🚧 See additional documentation for instructions on how to use the program. 🚧

📝 Note: Similar to Jupyter Notebook, Streamlit (and this script) creates a local webserver to simplify the UI. None of your data is actually uploaded to the internet when using this script. Close the python prompt to shut the server down.