Merge branch 'master' into punk778-patch-1

Author: gunthercox

.github/workflows/publish-documentation.yml

@@ -0,0 +1,21 @@
+name: Deploy Sphinx documentation to Pages
+
+on:
+  push:
+    branches: [master] # branch to trigger deployment
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3
+      with:
+        pyproject_extras: 'test'
+        sphinx_build_options: '-b dirhtml'

.github/workflows/python-package.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
 
     steps:
     - uses: actions/checkout@v2
@@ -26,14 +26,14 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Setup
       run: |
-        python -m pip install -r dev-requirements.txt
+        python -m pip install .[test]
     - name: Lint
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --show-source --statistics
     - name: Test code
       run: |
-        nosetests --with-coverage --cover-package=mathparse
+        python -m unittest discover -s tests
     - name: Test documentation
       run: |
         sphinx-build -nW -b html ./docs/ ./build/

.github/workflows/pythonpublish.yml

@@ -10,6 +10,7 @@ __pycache__/
 .Python
 env/
 build/
+html/
 develop-eggs/
 dist/
 downloads/

.gitignore

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Gunther Cox
+Copyright (c) 2025 Gunther Cox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -0,0 +1,43 @@
+# mathparse
+
+The `mathparse` library is a Python module designed to evaluate mathematical equations contained in strings.
+
+Here are a few examples:
+
+```python
+from mathparse import mathparse
+
+mathparse.parse('50 * (85 / 100)')
+>>> 42.5
+
+mathparse.parse('one hundred times fifty four', language='ENG')
+>>> 5400
+
+mathparse.parse('(seven * nine) + 8 - (45 plus two)', language='ENG')
+>>> 24
+```
+
+## Security
+
+Mathparse does not employ the use of Python's [`eval` function](https://docs.python.org/3/library/functions.html#eval) when evaluating provided mathematical expressions. This is a measure to prevent arbitrary code execution vulnerabilities. See https://mathparse.chatterbot.us/postfix/ for additional details.
+
+Mathparse is a standalone Python package and requires zero dependencies to function.
+
+## Language Support
+
+The language parameter must be set in order to evaluate an equation that uses word operators.
+The language code should be a valid [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php) language code.
+
+## Installation
+
+```bash
+pip install mathparse
+```
+
+## Documentation
+
+See the full documentation at https://mathparse.chatterbot.us
+
+## Changelog
+
+See [release notes](https://github.com/gunthercox/mathparse/releases) for changes.

README.md

@@ -0,0 +1,30 @@
+"""
+Add GitHub repository details to the Sphinx context.
+"""
+
+
+def setup_canonical_func(app, pagename, templatename, context, doctree):
+    """
+    Return the url to the specified page on GitHub.
+
+    (Sphinx 7.4 generates a canonical link with a .html extension even
+    when run in dirhtml mode)
+    """
+
+    conf = app.config
+
+    def canonical_func():
+        # Special case for the root index page
+        if pagename == 'index':
+            return conf.html_baseurl
+
+        dir_name = pagename.replace('/index', '/')
+        return f'{conf.html_baseurl}{dir_name}'
+
+    # Add it to the page's context
+    context['canonical_url'] = canonical_func
+
+
+# Extension setup function
+def setup(app):
+    app.connect('html-page-context', setup_canonical_func)

README.rst

@@ -0,0 +1,29 @@
+"""
+Add GitHub repository details to the Sphinx context.
+"""
+
+GITHUB_USER = 'gunthercox'
+GITHUB_REPO = 'mathparse'
+
+
+def setup_github_func(app, pagename, templatename, context, doctree):
+    """
+    Return the url to the specified page on GitHub.
+    """
+
+    github_version = 'master'
+    docs_path = 'docs'
+
+    def my_func():
+        return (
+            f'https://github.com/{GITHUB_USER}/{GITHUB_REPO}/blob/'
+            f'{github_version}/{docs_path}/{pagename}.rst'
+        )
+
+    # Add it to the page's context
+    context['github_page_link'] = my_func
+
+
+# Extension setup function
+def setup(app):
+    app.connect('html-page-context', setup_github_func)