remove redundant .md files

2 files changed, 0 insertions, 37 deletions

diff --git a/NOTES.md b/NOTES.md
deleted file mode 100644
index 9179c45..0000000
--- a/NOTES.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# Flow
-
-`from gdpr_obfuscator import Obfuscator`
-
-- User imports the `Obfuscator` class from the `gdpr_obfuscator` module
-    - This is the main entry point for the obfuscation tool
-- During instantiation, the `__init__()` constructor method creates an instance
-of `gdpr_obfuscator.read.DataReader` that is responsible for fetching data from
-local files of an S3 bucket
-    - The `read_local()` method called via `process_local()` opens the CSV file
-    at the path the user specifies, uses `csv.DictReader()` to parse the field,
-    and then return a list of dictionaries
-    - The `read_s3()` method called via `process_s3()` uses the `boto3` library to
-    fetch the CSV file from the S3 bucket, and then returns a list of
-    dictionaries
-- The outputs of both `read_local()` and `read_s3()` are then passed to the
-`obfuscate_data()` function in the `gdpr_obfuscator.obfuscate` module, which
-receives the data and the Personally Identifiable Information (PII) fields to
-obfuscate
-- Following this, the obfuscated data is passed into `create_byte_stream()` to
-create the byte stream that will be written to a new CSV file or S3 bucket
-object
-
diff --git a/TODO.md b/TODO.md
deleted file mode 100644
index 7b472ff..0000000
--- a/TODO.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# High Priority
-- [ ] Accept JSON string as input
-- [ ] Add support for JSON input data
-- [ ] Restore logging in a cleaner more centralised way
-- [ ] Write project documentation (README.md)
-- [ ] Improve language and detail in docstrings (autoDocstring - VSCode)
-
-# Medium Priority
-- [ ] Add custom exceptions (`exc.py`) and improve error handling
-- [ ] Add tests for timing and performance (memory usage on large CSV files etc)
-- [ ] Use Pydantic for data validation of JSON/CSV
-
-# Low Priority
-- [ ] Add .env file for environment variables (e.g. custom endpoints)
\ No newline at end of file