monopyly 1.4.1__tar.gz → 1.4.3__tar.gz

{monopyly-1.4.1 → monopyly-1.4.3}/.gitignore

@@ -69,8 +69,9 @@ target/
 # Mac custom attributes file
 .DS_Store
 
-# Virtual environment
+# Virtual environments
 monopyly-env/
+monopyly-production-env/
 
 # Hatch-generated version file
 monopyly/_version.py

{monopyly-1.4.1 → monopyly-1.4.3}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: monopyly
-Version: 1.4.1
+Version: 1.4.3
 Summary: A homemade personal finance manager.
 Project-URL: Download, https://pypi.org/project/monopyly
-Project-URL: Homepage, https://github.com/mitchnegus/monopyly
+Project-URL: Homepage, http://monopyly.com
 Project-URL: Repository, https://github.com/mitchnegus/monopyly
 Project-URL: Changelog, https://github.com/mitchnegus/monopyly/blob/main/CHANGELOG.md
 Author-email: Mitch Negus <mitchnegus57@gmail.com>
@@ -22,11 +22,12 @@ Classifier: Programming Language :: Python
 Classifier: Topic :: Office/Business :: Financial
 Classifier: Topic :: Office/Business :: Financial :: Accounting
 Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
-Requires-Python: <3.11,>=3.9
+Requires-Python: <3.11,>=3.10
 Requires-Dist: authanor>=1.0.2
 Requires-Dist: flask-wtf
 Requires-Dist: flask>=2.2.2
 Requires-Dist: fuisce>1.0.0
+Requires-Dist: gunicorn>=21.2.0
 Requires-Dist: markdown>=3.4.3
 Requires-Dist: python-dateutil
 Requires-Dist: sqlalchemy>=2.0.0
@@ -64,10 +65,10 @@ The package requires a recent version of Python (3.9+).
 Once the package is properly installed, run the app from the command line (the default options should be sensible, but you may customize the host and port if necessary):
 
 ```
-$ monopyly production [--host HOST] [--port PORT]
+$ monopyly development --browser [--host HOST] [--port PORT]
 ```
 
-This will open to an empty homepage with a welcome message.
+By using the `--browser` option in development mode, this will open to an empty homepage with a welcome message.
 
 <img class="screenshot" src="https://raw.githubusercontent.com/mitchnegus/monopyly/main/monopyly/static/img/about/homepage.png" alt="user homepage" width="800px">
 

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/README.md

@@ -30,10 +30,10 @@ The package requires a recent version of Python (3.9+).
 Once the package is properly installed, run the app from the command line (the default options should be sensible, but you may customize the host and port if necessary):
 
 ```
-$ monopyly production [--host HOST] [--port PORT]
+$ monopyly development --browser [--host HOST] [--port PORT]
 ```
 
-This will open to an empty homepage with a welcome message.
+By using the `--browser` option in development mode, this will open to an empty homepage with a welcome message.
 
 <img class="screenshot" src="monopyly/static/img/about/homepage.png" alt="user homepage" width="800px">
 

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/__init__.py

@@ -1,8 +1,6 @@
 """
 Run a development server for the Monopyly app.
 """
-import warnings
-
 from flask import Flask
 
 from monopyly.config import DevelopmentConfig, ProductionConfig
@@ -22,9 +20,6 @@ def create_app(test_config=None):
             config = DevelopmentConfig.configure_for_instance(app.instance_path)
         else:
             config = ProductionConfig.configure_for_instance(app.instance_path)
-            # Give an alert while the secret key remains insecure
-            warnings.formatwarning = lambda msg, *args, **kwargs: f"\n{msg}\n"
-            warnings.warn("INSECURE: Production mode has not yet been fully configured")
     app.config.from_object(config)
 
     # Initialize the app, including CLI commands and blueprints

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/_version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '1.4.1'
-__version_tuple__ = version_tuple = (1, 4, 1)
+__version__ = version = '1.4.3'
+__version_tuple__ = version_tuple = (1, 4, 3)

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/auth/routes.py

@@ -26,7 +26,9 @@ def register():
         # Get username and passwords from the form
         username, password = get_username_and_password(request.form)
         # Check for errors in the accessed information
-        if not username:
+        if not current_app.config["REGISTRATION"]:
+            error = "The app is not currently accepting new registrations."
+        elif not username:
             error = "Username is required."
         elif not password:
             error = "Password is required."

monopyly-1.4.3/monopyly/cli/apps.py

@@ -0,0 +1,84 @@
+"""Application objects for running the app via the CLI."""
+import multiprocessing
+import subprocess
+
+from gunicorn.app.base import BaseApplication
+
+from .. import create_app
+
+
+class LocalApplication:
+    """An object for running the application locally."""
+
+    default_port = "5001"
+    command = ["flask"]
+
+    def __init__(self, host=None, port=None, **options):
+        """Initialize the application in development mode."""
+        self._host = host
+        self._port = port
+        if options:
+            raise NotImplementedError(
+                "Options besides `host` and `port` are not handled in development mode."
+            )
+
+    def run(self):
+        """Run the Monopyly application in development mode."""
+        instruction = self.command + ["run"]
+        if self._host:
+            instruction += ["--host", self._host]
+        if self._port:
+            instruction += ["--port", self._port]
+        server = subprocess.Popen(instruction)
+
+
+class DevelopmentApplication(LocalApplication):
+    """An object for running the application in development mode."""
+
+    default_port = "5000"
+    command = LocalApplication.command + ["--debug"]
+
+
+class ProductionApplication(BaseApplication):
+    """An object for running the application in production mode (via Gunicorn)."""
+
+    default_port = "8000"
+    _default_worker_count = (multiprocessing.cpu_count() * 2) + 1
+
+    def __init__(self, host=None, port=None, **options):
+        """Initialize the application in production mode."""
+        options["bind"] = self._parse_binding(host, port, options.get("bind"))
+        options.setdefault("workers", self._default_worker_count)
+        self.options = options
+        self.application = create_app()
+        super().__init__()
+
+    @staticmethod
+    def _parse_binding(host, port, bind_option):
+        # Parse any socket binding options
+        if (host or port) and bind_option:
+            raise ValueError(
+                "Neither `host` nor `port` parameters can be specified if the "
+                "`bind` option is given."
+            )
+        bind_values = []
+        if host:
+            bind_values.append(host)
+        if port:
+            bind_values.append(port)
+        return bind if (bind := ":".join(bind_values)) else bind_option
+
+    def load_config(self):
+        config = {
+            key: value
+            for key, value in self.options.items()
+            if key in self.cfg.settings and value is not None
+        }
+        for key, value in config.items():
+            self.cfg.set(key.lower(), value)
+
+    def load(self):
+        return self.application
+
+    def run(self, *args, **kwargs):
+        return super().run(*args, **kwargs)

monopyly-1.4.3/monopyly/cli/run.py

@@ -0,0 +1,122 @@
+#!/usr/bin/env python
+"""
+A script (entry point) to launch the Monopyly application.
+"""
+import argparse
+import os
+import signal
+import subprocess
+import time
+import webbrowser
+from pathlib import Path
+from threading import Event
+
+from flask import current_app
+from rich.console import Console
+
+from .apps import DevelopmentApplication, LocalApplication, ProductionApplication
+
+# Set the Flask environment variable
+os.environ["FLASK_APP"] = "monopyly"
+
+
+def main():
+    args = parse_arguments()
+    app_launcher = Launcher(args.mode, host=args.host, port=args.port)
+    # Initialize the database and run the app
+    app_launcher.initialize_database()
+    if args.backup:
+        app_launcher.backup_database()
+    app_launcher.launch()
+    if args.mode in ("development", "local"):
+        # Enable browser viewing in development mode
+        if args.browser:
+            app_launcher.open_browser(delay=1)
+        # Wait for the exit command to stop
+        app_launcher.wait_for_exit()
+
+
+def parse_arguments():
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument("--host", help="the host address where the app will be run")
+    parser.add_argument("--port", help="the port where the app will be accessible")
+    parser.add_argument(
+        "--backup",
+        action="store_true",
+        help="a flag indicating if the database should be backed up",
+    )
+    parser.add_argument(
+        "--browser",
+        action="store_true",
+        help=(
+            "a flag indicating if a new browser window should be opened (development "
+            "and local modes only)"
+        ),
+    )
+    parser.add_argument(
+        "mode",
+        help="the runtime mode for the app",
+        choices=["development", "local", "production"],
+    )
+    return parser.parse_args()
+
+
+class Launcher:
+    """A tool to build and execute Flask commands."""
+
+    _application_types = {
+        "development": DevelopmentApplication,
+        "local": LocalApplication,
+        "production": ProductionApplication,
+    }
+    _console = Console()
+    _exit = Event()
+    command = ["flask"]
+
+    def __init__(self, mode, host=None, port=None):
+        app_type = self._application_types[mode]
+        self.host = host if host else "127.0.0.1"
+        self.port = port if port else app_type.default_port
+        self.app = app_type(host=self.host, port=self.port)
+
+    def initialize_database(self):
+        """Run the database initializer."""
+        instruction = self.command + ["init-db"]
+        self._console.print("[deep_sky_blue1]Initializing the database...")
+        subprocess.run(instruction)
+        print("\n")
+
+    def backup_database(self):
+        """Back up the app database."""
+        self._console.print("[deep_sky_blue1]Backing up the database...")
+        instruction = self.command + ["back-up-db"]
+        subprocess.run(instruction)
+        print("\n")
+
+    def launch(self):
+        """Launch the Monopyly application."""
+        self._console.print("[deep_sky_blue1]Running the Monopyly application...\n")
+        self.app.run()
+
+    def open_browser(self, delay=0):
+        """Open the default web browser."""
+        time.sleep(delay)
+        webbrowser.open(f"http://{self.host}:{self.port}/")
+
+    @classmethod
+    def wait_for_exit(cls):
+        """Wait for the exit command (e.g., keyboard interrupt) to be issued."""
+        for sig in ("TERM", "HUP", "INT"):
+            signal.signal(getattr(signal, "SIG" + sig), cls._quit)
+        while not cls._exit.is_set():
+            cls._exit.wait(1)
+
+    @classmethod
+    def _quit(cls, signo, _frame):
+        """Send the signal to quit the app."""
+        print("\nClosing the Monopyly app...")
+        cls._exit.set()
+
+
+if __name__ == "__main__":
+    main()

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/config/default_settings.py

@@ -1,11 +1,21 @@
 """Default configuration settings."""
+import json
 from pathlib import Path
 
+CONFIG_FILENAME = f"monopyly-config.json"
+DEFAULT_CONFIG_PATH = Path("/etc", CONFIG_FILENAME)
+
 
 class Config:
     """A base configuration object with some default settings."""
 
+    config_filepaths = [DEFAULT_CONFIG_PATH]
+    REGISTRATION = True
+
     def __init__(self, db_path=None):
+        # Read parameters from the configuration files in order of specificity
+        for config_filepath in filter(lambda p: p.exists(), self.config_filepaths):
+            self._read_config_json(config_filepath)
         if db_path:
             self.DATABASE = db_path
 
@@ -18,6 +28,13 @@ class Config:
         # Ensure that the database path is always set as a `pathlib.Path` object
         self._database = Path(value)
 
+    def _read_config_json(self, config_path):
+        # Read keys and values from a configuration JSON
+        with config_path.open() as config_json:
+            config_mapping = json.load(config_json)
+        for key, value in config_mapping.items():
+            setattr(self, key, value)
+
 
 class InstanceBasedConfig(Config):
     """A base configuration object for app modes using instance directories."""
@@ -30,5 +47,9 @@ class InstanceBasedConfig(Config):
         """Instantiate the app based out of the given instance directory."""
         instance_path = Path(instance_path)
         instance_path.mkdir(parents=True, exist_ok=True)
+        cls.config_filepaths = [
+            *super().config_filepaths,
+            instance_path / CONFIG_FILENAME,
+        ]
         db_path = Path(instance_path, cls.db_name) if cls.db_name else None
         return cls(db_path=db_path, **kwargs)

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/config/settings.py

@@ -1,4 +1,5 @@
 """A module containing objects with various configuration settings."""
+import warnings
 from pathlib import Path
 
 from ..database import BASE_DB_NAME
@@ -8,9 +9,19 @@ from .default_settings import Config, InstanceBasedConfig
 class ProductionConfig(InstanceBasedConfig):
     """A configuration object with settings for production."""
 
-    SECRET_KEY = "INSECURE PRODUCTION TEST KEY"
+    SECRET_KEY = "INSECURE"
     db_name = BASE_DB_NAME
 
+    def __init__(self, db_path=None):
+        super().__init__(db_path=db_path)
+        if self.SECRET_KEY == "INSECURE":
+            # Give an alert while the secret key remains insecure
+            warnings.formatwarning = lambda msg, *args, **kwargs: f"\n{msg}\n"
+            warnings.warn(
+                "INSECURE: Production mode has not yet been fully configured; "
+                "a secret key is required."
+            )
+
 
 class DevelopmentConfig(InstanceBasedConfig):
     """A configuration object with settings for development."""

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/core/routes.py

@@ -60,6 +60,7 @@ def about():
 
 
 @bp.route("/story")
+@login_required
 def story():
     return render_template("story.html")
 

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/database/__init__.py

@@ -11,7 +11,7 @@ from fuisce.database import SQLAlchemy as _SQLAlchemy
 
 from ..core.actions import get_timestamp
 
-BASE_DB_NAME = "monopyly.sqlite"
+BASE_DB_NAME = f"monopyly.sqlite"
 
 
 class SQLAlchemy(_SQLAlchemy):

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/static/css/style.css

@@ -252,8 +252,9 @@ aside.sidebar {
 
 .screenshot {
   width: 100%; /* override the markdown default */
+  margin: 20px 0;
   border: 1px solid #f3f3f3;
-  box-shadow: 3px 3px 2px #fafafa;
+  box-shadow: 3px 3px 5px #bbbbbb;
 }
 
 .grouping {
@@ -1207,6 +1208,7 @@ form .autocomplete-box .item.active {
 .transactions-table .expanded .setting .date {
   display: flex;
   flex-direction: column;
+  justify-content: center;
   align-items: center;
   flex: 2;
   padding-top: 3px;

monopyly-1.4.3/monopyly/static/jquery-3.7.0.min.js

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d8f9afbf492e4c139e9d2bcb9ba6ef7c14921eb509fb703bc7a3f911b774eff8
+size 87462

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/static/js/define-filter.js

@@ -11,7 +11,7 @@
 
 	// Identify the card filters
 	const $filterContainer = $('#card-filter');
-	
+
 	// Label inactive cards when they are hovered over
 	const inactiveCardFilters = $filterContainer.find('.inactive.card');
 	let defaultText;
@@ -31,7 +31,7 @@
 			$this.text(defaultText);
 		}
 	);
-	
+
 	// Change the filter status on click
 	const $filters = $filterContainer.find('.card');
 	$filters.on('click', function() {

monopyly-1.4.3/monopyly/static/js/expand-transaction.js

@@ -0,0 +1,18 @@
+/*
+ * Expand a transaction in a table when the plus icon is clicked.
+ *
+ * Expands a row in the transaction table when the plus icon offering
+ * more information is clicked. The expanded row shows transactions in
+ * more detail (and a larger font) than the rest of the transaction
+ * table. For both credit card and bank transactions, this expanded row
+ * shows subtransaction information.
+ */
+
+import {
+  TransactionToggleManager, displaySubtransactions
+} from './modules/expand-transaction.js';
+
+
+(function() {
+  const toggleManager = new TransactionToggleManager(displaySubtransactions)
+})();

monopyly-1.4.3/monopyly/static/js/modules/expand-transaction.js

@@ -0,0 +1,128 @@
+/*
+ * Expand a transaction when the plus icon is clicked.
+ *
+ * Expands a row in the transaction table when the plus icon offering
+ * more information is clicked. The expanded row shows transactions in
+ * more detail (and a larger font) than the rest of the transaction
+ * table. A user can exit the expanded view by clicking the 'x' icon
+ * button that is shown in the expanded view. The 'toggleTransactionRow'
+ * function takes an optional callback function which is executed after
+ * the row is expanded. The callback function receives the selected
+ * '.transaction' element as its only argument.
+ */
+
+import {
+  replaceDisplayContentsAjaxRequest
+} from './update-display-ajax.js';
+
+
+class TransactionToggleManager {
+  /**
+   * Create the object to toggle transactions.
+   *
+   * @param {function} callback - A callback function to execute when toggling
+   *     a button to get more info.
+   */
+  constructor(callback = null) {
+    // Identify the plus/minus icons
+    this.$iconsMoreInfoButtons = $('.transaction .more.button');
+    this.$iconsLessInfoButtons = $('.transaction .less.button');
+    this.#registerClickExpand(callback);
+    this.#registerClickCollapse();
+  }
+
+  getButtonTransaction(button) {
+    return $(button).closest('.transaction');
+  }
+
+  #registerClickExpand(callback) {
+    const self = this;
+    this.$iconsMoreInfoButtons.on('click', function() {
+      const $transaction = self.getButtonTransaction(this);
+      const toggler = new TransactionToggler($transaction);
+      toggler.expand(callback);
+    });
+  }
+
+  #registerClickCollapse() {
+    const self = this;
+    this.$iconsLessInfoButtons.on('click', function() {
+      const $transaction = self.getButtonTransaction(this);
+      const toggler = new TransactionToggler($transaction);
+      toggler.collapse();
+    });
+  }
+}
+
+
+class TransactionToggler {
+
+  /**
+   * Create the handler.
+   *
+   * @param {Object} $transaction - The transaction to be toggled.
+   */
+  constructor($transaction) {
+    // Set timing variables
+    this.fadeTime = 200;
+    this.slideTime = 250;
+    // Identify elements of the row
+    this.$transaction = $transaction;
+    this.$extendedRow = $transaction.find('.expanded');
+    this.$condensedRow = $transaction.find('.condensed');
+  }
+
+  /**
+   * Expand the transaction
+   *
+   * @param {function} callback - A callback function to execute when expanding
+   *     the transaction information. The callback function takes one argument,
+   *     the JQuery object representing the transaction.
+   */
+  expand(callback = null) {
+    // Execute the callback function, if given
+    if (callback != null) {
+      callback(this.$transaction);
+    }
+    this.#toggleTransaction(this.$condensedRow, this.$extendedRow);
+    this.$transaction.addClass('selected');
+  }
+
+  collapse($transaction) {
+    this.#toggleTransaction(this.$extendedRow, this.$condensedRow);
+    this.$transaction.removeClass('selected');
+  }
+
+  #toggleTransaction($collapser, $expander) {
+    this.#hideSummaryRow($collapser);
+    this.#showSummaryRow($expander)
+  }
+
+  #hideSummaryRow($row) {
+    const self = this;
+    $row.fadeTo(self.fadeTime, 0, function() {
+      $(this).slideUp(self.slideTime);
+    });
+  }
+
+  #showSummaryRow($row) {
+    const self = this;
+    $row.delay(self.fadeTime).slideDown(self.slideTime, function() {
+      $(this).fadeTo(self.fadeTime, 1);
+    });
+  }
+}
+
+
+function displaySubtransactions($transaction) {
+
+    // Execute an AJAX request to get transaction/subtransaction information
+    const endpoint = EXPAND_TRANSACTION_ENDPOINT;
+    const rawData = $transaction.data("transaction-id");
+    const $container = $transaction.find('.subtransaction-container');
+    replaceDisplayContentsAjaxRequest(endpoint, rawData, $container);
+
+}
+
+
+export { TransactionToggleManager, displaySubtransactions };

{monopyly-1.4.1 → monopyly-1.4.3}/monopyly/static/js/modules/update-display-ajax.js

@@ -11,14 +11,21 @@
 import { executeAjaxRequest } from './ajax.js';
 
 
-function replaceDisplayContentsAjaxRequest(endpoint, rawData, $display) {
-
-	// The action is to replace the display's contents
-	function action(response) {
-		$display.html(response);
-	}
-	// Assign the response to the display object
-	executeAjaxRequest(endpoint, rawData, action);
+function replaceDisplayContentsAjaxRequest(
+  endpoint, rawData, $display, callback = null
+) {
+
+  // The action is to replace the display's contents
+  function action(response) {
+    $display.html(response);
+    // Execute the callback function, if given
+    if (callback != null) {
+      callback();
+    }
+  }
+
+  // Assign the response to the display object
+  executeAjaxRequest(endpoint, rawData, action);
 
 }