Updated section documentation

This commit is contained in:
Chapin Bryce 2019-11-03 08:02:37 -05:00
parent 5be3e71173
commit d4d372a02e
3 changed files with 7 additions and 5 deletions

View File

@ -15,7 +15,7 @@ Section 1.2 - Logging Example
:members: :members:
Section 1.3 - Open Files Section 1.3 - Open Files
-------------------------------- ------------------------
.. automodule:: sections.section_01.open_files .. automodule:: sections.section_01.open_files
:members: :members:

View File

@ -20,6 +20,8 @@ projects to allow for uniformity.
* Logging * Logging
- Writing status and error messages to the console and - Writing status and error messages to the console and
log file log file
* Open Files
- Read text files with varying UTF encodings.
* CSV Generation * CSV Generation
- For better or worse, CSV reports are very common in DFIR - For better or worse, CSV reports are very common in DFIR
and this code block covers several methods for and this code block covers several methods for

View File

@ -1,8 +1,8 @@
"""Example for writing datasets into CSV files. """Example for reading data from encoded text files.
Demonstrates source datasets comprised of lists of dictionaries Demonstrates how to handle setting the proper encoding for
and lists of lists as separate functions. Example data is UTF-8, UTF-16-LE, and UTF-16-BE with the ability to easily
provided in line and will generate two identical CSVs as output. expand to support checking other file magic values/signatures.
Example Usage: Example Usage: