doc

Author: GiorgioMedico

README.md

@@ -10,6 +10,7 @@
 - [InterpolatePy](#interpolatepy)
   - [Table of Contents](#table-of-contents)
   - [Overview](#overview)
+  - [Future Implementations](#future-implementations)
   - [Key Features](#key-features)
     - [Spline Interpolation](#spline-interpolation)
       - [B-Splines](#b-splines)
@@ -42,13 +43,29 @@
   - [Contributing](#contributing)
   - [License](#license)
   - [Acknowledgments](#acknowledgments)
+  - [Citation](#citation)
 
 ## Overview
 
 InterpolatePy is a comprehensive Python library for generating smooth trajectories and curves with precise control over position, velocity, acceleration, and jerk profiles. Designed for robotics, motion planning, computer graphics, and scientific computing applications, it provides a wide range of interpolation techniques from simple linear interpolation to advanced B-splines and motion profiles.
 
 Whether you need to generate smooth robotic joint motions, create path planning for autonomous vehicles, or design animation curves with specific dynamic properties, InterpolatePy offers the tools to create trajectories that maintain continuity while adhering to physical constraints.
 
+## Future Implementations
+
+InterpolatePy is continuously evolving, with several exciting features planned for future releases:
+
+- [ ] **Bezier Curves**: Implementation of parametric Bezier curves with arbitrary degree control
+- [ ] **Linear Interpolation with Polynomial Blend**: Enhanced linear interpolation using quintic Bezier curves for smooth transitions between line segments
+- [ ] **Linear Interpolation with Parabolic Blends**: An alternative blending approach using parabolic segments for smooth connections
+- [ ] **Spherical Path**: Tools for interpolation along great circles and spherical paths
+- [ ] **LERP (Linear Interpolation)**: More comprehensive linear interpolation functions for quaternions
+- [ ] **SLERP (Spherical Linear Interpolation)**: Algorithms for smooth interpolation between orientations represented as quaternions
+- [ ] **SQUAD (Spherical and Quadrangle)**: Advanced spherical interpolation with cubic-like smoothness for quaternion interpolation
+- [ ] **B-spline Quaternion Curves**: Extension of B-spline techniques to quaternion space for smooth orientation interpolation
+
+These implementations will significantly enhance InterpolatePy's capabilities for orientation interpolation and complex curve generation, particularly for robotic applications, character animation, and camera path planning.
+
 ## Key Features
 
 ### Spline Interpolation
@@ -368,3 +385,18 @@ InterpolatePy implements algorithms and mathematical concepts primarily from the
 The library's implementation draws heavily from the theoretical frameworks, mathematical formulations, and algorithms presented in these works.
 
 I express my gratitude to these authors for their significant contributions to the field of trajectory planning and robotics, which have made this library possible.
+
+## Citation
+
+If you use InterpolatePy in your research or project, please cite it as follows:
+
+```bibtex
+@software{InterpolatePy,
+  author = {Medico, Giorgio},
+  title = {InterpolatePy: A Comprehensive Python Library for Trajectory Planning and Interpolation},
+  year = {2025},
+  url = {https://github.com/GiorgioMedico/InterpolatePy}
+}
+```
+
+For specific methods or algorithms implemented in InterpolatePy, please also consider citing the original research papers or textbooks referenced in the documentation and acknowledgments section.

pyproject.toml

@@ -1,15 +1,34 @@
 [build-system]
-requires = ["setuptools", "setuptools-scm", "numpy>=2.0.0", "scipy>=1.15.2"]
+requires = ["setuptools>=68.2.2", "setuptools-scm>=7.1.0", "wheel>=0.41.2"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "InterpolatePy"
 authors = [{ name = "Giorgio Medico", email = "giorgio.medico11@gmail.com" }]
-description = "This is a lib on interpolations in python."
+maintainers = [
+    { name = "Giorgio Medico", email = "giorgio.medico11@gmail.com" },
+]
+description = "A comprehensive Python library for generating smooth trajectories and curves with precise control over position, velocity, acceleration, and jerk profiles"
 readme = "README.md"
-license = "MIT"
+license = { text = "MIT" }
 requires-python = ">=3.11"
+keywords = [
+    "interpolation",
+    "trajectory planning",
+    "motion profiles",
+    "robotics",
+    "b-splines",
+    "cubic splines",
+    "frenet frames",
+    "path generation",
+    "motion control",
+]
 classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -18,18 +37,45 @@ classifiers = [
     "Operating System :: POSIX",
     "Operating System :: Unix",
     "Operating System :: MacOS",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 dependencies = ["numpy>=2.0.0", "matplotlib>=3.10.1", "scipy>=1.15.2"]
 dynamic = ["version"]
 
+[project.urls]
+"Homepage" = "https://github.com/GiorgioMedico/InterpolatePy"
+"Bug Tracker" = "https://github.com/GiorgioMedico/InterpolatePy/issues"
+"Repository" = "https://github.com/GiorgioMedico/InterpolatePy.git"
+"Documentation" = "https://github.com/GiorgioMedico/InterpolatePy#readme"
+
 [project.optional-dependencies]
-test = ["pytest", "pytest-cov", "codecov", "pre-commit"]
-dev = ["black", "isort", "mypy", "pre-commit", "ruff"]
+test = [
+    "pytest>=7.3.1",
+    "pytest-cov>=4.1.0",
+    "pytest-benchmark>=4.0.0",
+    "codecov>=2.1.13",
+    "pre-commit>=4.1.0",
+]
+dev = [
+    "black>=23.11.0",
+    "isort>=5.12.0",
+    "mypy>=1.6.1",
+    "pre-commit>=4.1.0",
+    "ruff>=0.1.5",
+    "pyright>=1.1.335",
+    "build>=1.0.3",
+    "twine>=4.0.2",
+]
 all = ["interpolatepy[test,dev]"]
 
 [tool.setuptools]
 platforms = ["unix", "linux", "osx", "cygwin", "win32"]
-packages = ["interpolatepy"]                            # optional
+packages = ["interpolatepy"]
 
 [tool.setuptools.dynamic]
 version = { attr = "interpolatepy.__version__" }