From b052f84230a428fcfeed718b637226c8fca78413 Mon Sep 17 00:00:00 2001
From: Ben Boonstra <bboonstra26@gmail.com>
Date: Wed, 23 Oct 2024 17:40:05 -0500
Subject: [PATCH] Release Candidate 1.3.0 [test] [docs]

---
 CHANGELOG.md                      |  4 --
 docs/docs/advanced-usage.html     |  3 +-
 docs/docs/technical/config.html   | 66 +++++++++++++++++++++++--------
 docs/docs/technical/db.html       | 41 ++++++++++++++++++-
 docs/docs/technical/technical.css |  6 +++
 docs/docs/technical/technical.js  | 12 +++++-
 effortless/configuration.py       |  2 +-
 setup.py                          |  2 +-
 8 files changed, 109 insertions(+), 27 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6d91fda..82567f6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -26,10 +26,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - EffortlessConfig now takes keyword parameters instead of a dictioniary
   - Use from_dict if you need the old functionality
 
-### Docs
-
-- TODO
-  
 ## [1.2.0.1] - 2024-10-22
 
 ### Added
diff --git a/docs/docs/advanced-usage.html b/docs/docs/advanced-usage.html
index 6e31250..0609712 100644
--- a/docs/docs/advanced-usage.html
+++ b/docs/docs/advanced-usage.html
@@ -41,8 +41,7 @@ <h2>Configuring the Database</h2>
             <p>You can futher customize the database with a configuration:</p>
             <!-- prettier-ignore -->
             <div class="command python">
-                config = EffortlessConfig()
-                config.readonly = True
+                config = EffortlessConfig(readonly=True)
                 db.configure(config)
                 # The database contents are now read-only
                 db.add({"Anything": "will not work"})  # Raises an error
diff --git a/docs/docs/technical/config.html b/docs/docs/technical/config.html
index f356598..330c720 100644
--- a/docs/docs/technical/config.html
+++ b/docs/docs/technical/config.html
@@ -23,26 +23,30 @@ <h1 class="technical-title">EffortlessConfig</h1>
             <h3 class="prop-header">Properties</h3>
             <div class="properties-container">
                 <div class="property">
-                    <h4 class="prop-subheader" prop-type="list">requires</h4>
+                    <h4 class="prop-subheader" prop-type="list">
+                        required_fields
+                    </h4>
                     <p class="prop-description">
                         Require fields for each entry in the DB.
                     </p>
                     <!-- prettier-ignore -->
                     <div class="command python example-usage">
-                        config.requires = ["id"]
+                        config = EffortlessConfig(required_fields=["id"])
                         db.configure(config)
                         db.add({}) # Error: Field 'id' is required
                     </div>
                 </div>
                 <div class="property">
-                    <h4 class="prop-subheader" prop-type="string">backup</h4>
+                    <h4 class="prop-subheader" prop-type="string">
+                        backup_path
+                    </h4>
                     <p class="prop-description">
                         Make the database automatically back up to the specified
                         path.
                     </p>
                     <!-- prettier-ignore -->
                     <div class="command python example-usage">
-                        config.backup = "/folder/backups/"
+                        config = EffortlessConfig(backup="/folder/backups/")
                         db.configure(config)
                         db.add({"data": True})
                         print(os.path.exists("/folder/backups/db.effortless"))
@@ -99,26 +103,27 @@ <h4 class="prop-subheader" prop-type="bool">encrypted</h4>
                     </p>
                 </div>
                 <div class="property">
-                    <h4 class="prop-subheader" prop-type="v1">version</h4>
+                    <h4 class="prop-subheader" prop-type="string">version</h4>
                     <p class="prop-description">
-                        The internal version of the database.
+                        The internal version of the database. This is used for
+                        automatic migration between versions of Effortless.
                     </p>
                 </div>
             </div>
             <h2 class="method-header">Methods</h2>
             <div class="methods-container">
                 <div class="method">
-                    <h4
-                        class="method-subheader"
-                        method-parameters="options: dict"
-                    >
+                    <h4 class="method-subheader" method-parameters="properties">
                         __init__
                     </h4>
                     <p class="method-description">
-                        Creates an EffortlessConfig with the given configuration
-                        options. EffortlessConfig creation will be changed in
-                        1.3.0.
+                        Creates an EffortlessConfig with any specified
+                        configuration options.
                     </p>
+                    <!-- prettier-ignore -->
+                    <div class="command python example-usage">
+                        config = EffortlessConfig(compressed=True, required_field=["name"])
+                    </div>
                 </div>
                 <div class="method">
                     <h4 class="method-subheader" method-returns="dict">
@@ -126,17 +131,46 @@ <h4 class="method-subheader" method-returns="dict">
                     </h4>
                     <p class="method-description">
                         Converts the configuration to a dictionary
-                        representation. You can use this to edit a config before
-                        re-applying it.
+                        representation. You can use this to save a config or
+                        edit a config as a dict before re-applying it.
                     </p>
                     <!-- prettier-ignore -->
                     <div class="command python example-usage">
                         config_dict = config.to_dict()
                         for opt in config_dict:
                         ‎   ...
-                        config = EffortlessConfig(config_dict)
                     </div>
                 </div>
+                <div class="method">
+                    <h4
+                        class="method-subheader"
+                        at="classmethod"
+                        method-returns="EffortlessConfig"
+                    >
+                        from_dict
+                    </h4>
+                    <p class="method-description">
+                        Converts a dictionary into an EffortlessConfig object.
+                    </p>
+                    <!-- prettier-ignore -->
+                    <div class="command python example-usage">
+                        config = EffortlessConfig.from_dict({"readonly": True})
+                    </div>
+                </div>
+                <div class="method">
+                    <h4
+                        class="method-subheader"
+                        method-parameters="db: EffortlessDB"
+                    >
+                        validate_db
+                    </h4>
+                    <p class="method-description">
+                        Checks if the given database follows the configured
+                        rules. Raises ValueError if anything doesn't follow.
+                        This must pass for a new configuration to be applied to
+                        a database.
+                    </p>
+                </div>
             </div>
             <div class="button-container">
                 <a href="db.html" class="tab tab-back">EffortlessDB</a>
diff --git a/docs/docs/technical/db.html b/docs/docs/technical/db.html
index c280755..0aa1756 100644
--- a/docs/docs/technical/db.html
+++ b/docs/docs/technical/db.html
@@ -31,13 +31,22 @@ <h4 class="prop-subheader" prop-type="EffortlessConfig">
                         that holds the configuration settings for the database.
                     </p>
                 </div>
+                <div class="property">
+                    <h4 class="prop-subheader" prop-type="string">
+                        encryption_key
+                    </h4>
+                    <p class="prop-description">
+                        The encryption key (password) used to encrypt and
+                        decrypt the database.
+                    </p>
+                </div>
             </div>
             <h2 class="method-header">Methods</h2>
             <div class="methods-container">
                 <div class="method">
                     <h4
                         class="method-subheader"
-                        method-parameters="db_name: string"
+                        method-parameters="db_name: string, encryption_key: string"
                     >
                         __init__
                     </h4>
@@ -46,7 +55,8 @@ <h2 class="method-header">Methods</h2>
                         database name. If no name is provided, it defaults to
                         "db". For example, passing in "users" will create a
                         database with the file "users.effortless" in the current
-                        directory.
+                        directory. If an encryption_key is provided, it will be
+                        used to encrypt/decrypt the database.
                     </p>
                     <!-- prettier-ignore -->
                     <div class="command python example-usage">
@@ -205,6 +215,33 @@ <h2 class="method-header">Methods</h2>
                         <a href="config.html">EffortlessConfig</a> object.
                     </p>
                 </div>
+                <div class="method">
+                    <h4
+                        class="method-subheader"
+                        method-parameters="new_key: string"
+                    >
+                        encrypt
+                    </h4>
+                    <p class="method-description">
+                        Sets a new encryption key and re-encrypts the database
+                        if necessary. If the database is already encrypted, this
+                        method will attempt to decrypt with both the old and new
+                        keys, then re-encrypt with the new key.
+                    </p>
+                </div>
+                <div class="method">
+                    <h4
+                        class="method-subheader"
+                        method-parameters="new_key: string"
+                    >
+                        unencrypt
+                    </h4>
+                    <p class="method-description">
+                        Permanently unencrypts the database using the encryption
+                        key if the database is currently encrypted. Raises a
+                        ValueError if an encryption key is not set.
+                    </p>
+                </div>
                 <div class="method">
                     <h4
                         class="method-subheader"
diff --git a/docs/docs/technical/technical.css b/docs/docs/technical/technical.css
index 533606e..fee44a5 100644
--- a/docs/docs/technical/technical.css
+++ b/docs/docs/technical/technical.css
@@ -119,6 +119,12 @@
     color: var(--background-color);
 }
 
+.at {
+    background-color: var(--secondary-color);
+    color: var(--background-color);
+    margin: 0px;
+}
+
 @media (max-width: 768px) {
     .technical-title {
         font-size: 2rem;
diff --git a/docs/docs/technical/technical.js b/docs/docs/technical/technical.js
index 9cbe2e4..978e2cf 100644
--- a/docs/docs/technical/technical.js
+++ b/docs/docs/technical/technical.js
@@ -4,7 +4,7 @@ document.addEventListener("DOMContentLoaded", function () {
         const formattedAttr = document.createElement("span");
         formattedAttr.className = `formatted-attr ${attrName}`;
         formattedAttr.textContent = content;
-        if (attrName === "prop-type") {
+        if (attrName === "prop-type" || attrName === "at") {
             element.insertBefore(formattedAttr, element.firstChild);
         } else {
             element.appendChild(formattedAttr);
@@ -44,4 +44,14 @@ document.addEventListener("DOMContentLoaded", function () {
                 );
             }
         });
+
+    // Add formatted attributes for 'at'
+    document
+        .querySelectorAll(".method-subheader[at]")
+        .forEach((method) => {
+            const atValue = method.getAttribute("at");
+            if (atValue && atValue.trim() !== "") {
+                createFormattedAttribute(method, "at", atValue);
+            }
+        });
 });
diff --git a/effortless/configuration.py b/effortless/configuration.py
index 904c943..7588ee9 100644
--- a/effortless/configuration.py
+++ b/effortless/configuration.py
@@ -146,7 +146,7 @@ def to_dict(self) -> Dict[str, Any]:
             "compressed": self.compressed,
             "readonly": self.readonly,
         }
-
+    
     @classmethod
     def from_dict(cls, config_dict: Dict[str, Any]) -> "EffortlessConfig":
         """
diff --git a/setup.py b/setup.py
index 98c362b..aad7828 100644
--- a/setup.py
+++ b/setup.py
@@ -4,7 +4,7 @@
 
 setup(
     name="Effortless",
-    version="1.2.0.1",
+    version="1.3.0",
     packages=find_packages(),
     description="Databases should be Effortless.",
     long_description=open("README.md").read(),