Skip to content

Commit

Permalink
README formatting fix
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinUhr committed Jun 18, 2024
1 parent 4942a20 commit bb66479
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,20 @@ This script takes a csv spreadsheet of FileMaker Pro data and adds new columns t
pip install -r requirements.txt
```

## Usage
1. If you have not already done so, activate the virtual environment (if you created one):
```shell
source [virtual environment name]/bin/activate
```
2. Run the script using the following command:
```shell
python fmp_data_munge.py [fmp_file] [student_file] [output_file] [orgs_file]
```
The `fmp_file` is the path to the input CSV file. The `student_file` is the path to the "student spreadsheet" CSV file. The `output_file` is the path to the output CSV file. The output file will be created if it does not exist and will be overwritten if it does. The default output file path is `../output/processed_data.csv`. The `orgs_file` is the path to the txt file containing the list of organizations to include. If `orgs_file` is not provided, all organizations will be included. If there are spaces in any file path, enclose the path in quotes.
## Usage
1. If you have not already done so, activate the virtual environment (if you created one):
```shell
source [virtual environment name]/bin/activate
```
2. Run the script using the following command:
```shell
python fmp_data_munge.py [fmp_file] [student_file] [output_file] [orgs_file]
```
The `fmp_file` is the path to the input CSV file. The `student_file` is the path to the "student spreadsheet" CSV file. The `output_file` is the path to the output CSV file. The output file will be created if it does not exist and will be overwritten if it does. The default output file path is `../output/processed_data.csv`. The `orgs_file` is the path to the txt file containing the list of organizations to include. If `orgs_file` is not provided, all organizations will be included. If there are spaces in any file path, enclose the path in quotes.

example:
```shell
python fmp_data_munge.py "My Files/fmp_data.csv" "My Files/student_data.csv" "My Files/output_data.csv" "My Files/orgs.txt"
example:
```shell
python fmp_data_munge.py "My Files/fmp_data.csv" "My Files/student_data.csv" "My Files/output_data.csv" "My Files/orgs.txt"
```

## Contributing
Expand Down

0 comments on commit bb66479

Please sign in to comment.