diffstep 1.1.1__tar.gz → 1.1.3__tar.gz

diffstep-1.1.3/CHANGELOG.txt

@@ -0,0 +1,54 @@
+# CHANGELOG
+
+## [1.0.0] - 2026-02-13
+### Added
+- Initial public release of diffstep
+- Expression validation and normalization
+- Tokenization engine
+- AST parser
+- Symbolic differentiation
+- AST to string printer
+- Expression simplification
+
+## [1.1.0] - 2026-03-02
+### Added
+- New lowercase `diffstep()` public API function
+
+### Deprecated
+- `DiffStep()` function is now deprecated and will be removed in a future major version
+- Users should migrate to `diffstep()`
+
+### Internal
+- Improved API consistency (PEP8 naming conventions)
+
+## [1.1.1] - 2026-03-03
+### Bugfix
+- Fixed bug where you could not import diffstep from terminal
+
+## [1.1.2] - 2026-03-13
+
+### Added
+- Layered API design to support both beginner and advanced users
+- Simple entry-point function `diffstep()` for quick differentiation
+- Additional public functions for more granular control of the differentiation pipeline
+- Support for accessing lower-level functions through `import diffstep` (e.g. `diffstep.differentiate()`)
+
+### Changed
+- Improved package structure to expose both high-level and low-level APIs
+- Updated `__init__.py` to limit wildcard imports (`from diffstep import *`) to the beginner-friendly `diffstep()` function
+
+### Developer
+- Refactored internal pipeline to support multiple public entry points
+
+## [1.1.3] - 2026-03-17
+
+### Added
+- New `gradient(expression, x_value)` function to evaluate the derivative at a specific x-value
+- New `normalise_expression(expression)` helper for expression normalization
+- New `tokenise_expression(expression)` helper for expression tokenization
+- New `parse_expression(expression)` helper for parsing expressions into AST form
+- New `derived_ast(expression)` helper to return the derivative AST before simplification
+
+### Changed
+- Expanded pipeline-level API to support step-by-step differentiation workflows
+

{diffstep-1.1.1/diffstep.egg-info → diffstep-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diffstep
-Version: 1.1.1
+Version: 1.1.3
 Summary: A symbolic differentiation library.
 Home-page: https://campus.cs.le.ac.uk/gitlab/ug_project/25-26/aoe8
 Author: Ayo

{diffstep-1.1.1 → diffstep-1.1.3}/diffstep/__init__.py

@@ -1,4 +1,6 @@
 from .pipeline import DiffStep, diffstep
+from .pipeline import differentiate, gradient, normalise_expression
+# from .pipeline import tokenise_expression, parse_expression, derived_ast
 
 __all__ = ["DiffStep", "diffstep"]
 # This file shows what can be called when you import diffstep. It also allows you to import from diffstep without having to specify the submodule, e.g. from diffstep import DiffStep instead of from diffstep.pipeline import DiffStep.

diffstep-1.1.3/diffstep/pipeline.py

@@ -0,0 +1,57 @@
+import warnings
+import sympy as sp
+
+from diffstep.core.normalise import validate_and_normalise as normalise
+from diffstep.core.tokeniser import tokenize
+from diffstep.core.parser import parse
+from diffstep.differentiation.derivative import differentiate as _differentiate
+from diffstep.printer.to_string import ast_to_string
+from diffstep.simplify.simplify import simplify
+
+# This is the main function that users will call to differentiate an expression.
+def DiffStep(expression: str):
+    warnings.warn(
+        "DiffStep is deprecated and will be removed in a future version. \n "
+        "Use 'diffstep' instead.",
+        category=DeprecationWarning,
+        stacklevel=2
+    )
+
+    return diffstep(expression)
+    
+
+def diffstep(expression: str):
+    normalised_expression = normalise(expression)
+    tokens = tokenize(normalised_expression)
+    ast = parse(tokens)
+    derivative_ast = _differentiate(ast)
+    result = simplify(derivative_ast)
+
+    return result
+
+def differentiate(expression: str):
+    return diffstep(expression)
+
+def gradient(expression: str, x_value: float):
+    x = sp.symbols('x')
+    derivative = diffstep(expression)
+    gradient_value = derivative.subs(x, x_value)
+    return gradient_value
+
+def normalise_expression(expression: str):
+    return normalise(expression)
+
+def tokenise_expression(expression: str):
+    normalised_expression = normalise(expression)
+    return tokenize(normalised_expression)
+
+def parse_expression(expression: str):
+    normalised_expression = normalise(expression)
+    tokens = tokenize(normalised_expression)
+    return parse(tokens)
+
+def derived_ast(expression: str):
+    normalised_expression = normalise(expression)
+    tokens = tokenize(normalised_expression)
+    ast = parse(tokens)
+    return _differentiate(ast)

{diffstep-1.1.1 → diffstep-1.1.3/diffstep.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diffstep
-Version: 1.1.1
+Version: 1.1.3
 Summary: A symbolic differentiation library.
 Home-page: https://campus.cs.le.ac.uk/gitlab/ug_project/25-26/aoe8
 Author: Ayo

{diffstep-1.1.1 → diffstep-1.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "diffstep"
-version = "1.1.1"
+version = "1.1.3"
 description = "A symbolic differentiation library."
 readme = "README.md"
 requires-python = ">=3.9"

{diffstep-1.1.1 → diffstep-1.1.3}/setup.py

@@ -11,7 +11,7 @@ classifiers = [
 
 setup (
     name='diffstep',
-    version='1.1.1',
+    version='1.1.3',
     description="This is a library for Algorithmic Differentiation.",
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',

diffstep-1.1.1/CHANGELOG.txt

@@ -1,22 +0,0 @@
-# CHANGELOG
-
-## [1.0.0] - 2026-02-13
-### Added
-- Initial public release of diffstep
-- Expression validation and normalization
-- Tokenization engine
-- AST parser
-- Symbolic differentiation
-- AST to string printer
-- Expression simplification
-
-## [1.1.0] - 2026-03-02
-### Added
-- New lowercase `diffstep()` public API function
-
-### Deprecated
-- `DiffStep()` function is now deprecated and will be removed in a future major version
-- Users should migrate to `diffstep()`
-
-### Internal
-- Improved API consistency (PEP8 naming conventions)

diffstep-1.1.1/diffstep/pipeline.py

@@ -1,29 +0,0 @@
-import warnings
-
-from diffstep.core.normalise import validate_and_normalise as normalise
-from diffstep.core.tokeniser import tokenize
-from diffstep.core.parser import parse
-from diffstep.differentiation.derivative import differentiate
-from diffstep.printer.to_string import ast_to_string
-from diffstep.simplify.simplify import simplify
-
-# This is the main function that users will call to differentiate an expression.
-def DiffStep(expression: str):
-    warnings.warn(
-        "DiffStep is deprecated and will be removed in a future version. \n "
-        "Use 'diffstep' instead.",
-        category=DeprecationWarning,
-        stacklevel=2
-    )
-
-    return diffstep(expression)
-    
-
-def diffstep(expression: str):
-    normalised_expression = normalise(expression)
-    tokens = tokenize(normalised_expression)
-    ast = parse(tokens)
-    derivative_ast = differentiate(ast)
-    result = simplify(derivative_ast)
-
-    return result