Skip to content

Convert Requirements to CSV #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cgrain wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Convert Requirements to CSV #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
59c090b
Prep output
CoenvanGruijthuijsen Apr 13, 2022
7de7f90
Add Requirements extractor
CoenvanGruijthuijsen Apr 13, 2022
f997d5e
Test script
CoenvanGruijthuijsen Apr 13, 2022
07d91cd
Added Documentation
CoenvanGruijthuijsen Apr 13, 2022
194d643
Fix Documentation
CoenvanGruijthuijsen Apr 13, 2022
a8510d0
Update RequirementsDesignNotes.md
cgrain Apr 14, 2022
4310a97
Remove line breaks
CoenvanGruijthuijsen Apr 14, 2022
7d7d706
Extract more Standard links
CoenvanGruijthuijsen Apr 19, 2022
ad8958c
Update XML 2 CSV with linking to other parts of the Norm
CoenvanGruijthuijsen Apr 21, 2022
595ee4e
Clean up
CoenvanGruijthuijsen Apr 21, 2022
91ad6c4
Fixing some debugs
CoenvanGruijthuijsen Apr 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
__pycache__
*.csv
test.csv
output.csv
data/*
30 changes: 30 additions & 0 deletions RequirementsDesignNotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Design notes

## Requirements

### Extraction from XML
All `<P>` tags contained in `<body><sec>`, with the exception of the following:
- [x] `<P>` contained in a section with type `scope` or `terms`
- [ ] `<P>` contained in a section with id `sec_forword`
- [ ] ... ?
### CSV format
The columns of the CSV format are the following:

Req_UUID,Text,Standard,Section
The CSV is UTF-8 encoded.
The Req_UUID is unique for every requirement. It is also new for every iteration of the script. It is however used to link requirements to additional information sets. (See the next section)

## Link Requirements with Additional Information such as Tables, etc.

### Extraction from XML
The following information elements are extracted:
- [ ] References to other Norms.
- [ ] References to tables/numerated lists/unnumerated lists with a ID link.
- [ ] tables/numerated lists/unnumerated in the same section as a paragraph without any ID link pointing to it.
- [ ] ... ?

### CSV Format
The format of the CSV output file is the following:

Req_UUID,AdditionalInfo_Type, AdditionalInfo_UUID, StandardID, SectionID, ID, AdditionalInfo_Body.
References to norms only have the Req_UUID, AdditionalInfo_Type and StandardID filled in. The CSV is encoded in UTF-8. The Req_UUID is the same as the UUID used in the first iteration, if and only if both CSV files are created in the same iteration.
Loading