v4.0.0

What's Changed

• Implemented CI/CD
• Addressed feedback from Milestones 1 and 2
• Addressed feedback from peer review sessions
• Agreed on using MIT license

v3.1.1

v3.1.1 (2025-01-31)

Bug Fixes

• Changed fml to fml_doc_gen in contributing.md for consistency (65f7021)

• Changed fml to fml_doc_gen in contributing.md for consistency (ef239a8)

• Temp fixed the error on example.ipynb (189e81b)

---

Detailed Changes: v3.1.0...v3.1.1

v3.1.0

v3.1.0 (2025-01-31)

Bug Fixes

• Minor fix in test_fml_doc_gen integration test (cda0fce)

• Small bug fix in read_use_function test suite (53c0eeb)

Documentation

• Updated Jupyter notebook with auto_generate usage documentation (7a7fafe)

• Updated example notebook to demonstrate the usage of auto_generate

• Added step-by-step instructions for setting up OpenAI API key

• Included example function calls and expected outputs

• Added dotenv and openai dependencies to toml

• Updated Jupyter notebook with auto_generate usage documentation (fb15a91)

• Updated example Jupyter notebook to demonstrate the usage of generate_docstring_template wih auto_generate

• Added step-by-step instructions for setting up OpenAI API key

• Included example function calls and expected outputs

• Added dotenv and open ai dependency to toml file

• readme: Add test running instructions (9331a29)

Added a section to the README detailing how to run tests using pytest and measure code coverage with poetry.

• readme: Function return type in README (8b195f0)

Features

• Add AI-powered docstring generation function (8df0b50)

Added fill_docstring_with_ai function to automatically generate detailed docstrings using OpenAI's GPT-4. This function takes a docstring template and function source as inputs and returns a completed docstring.

• Loads API key using dotenv

• Uses OpenAI's API for docstring completion

• Implements error handling for missing inputs and API failures

• Add PEP8 compliance and type checking to read_user_function (cf98f06)

• Implemented explicit type checking for function input

• Reformatted code to align with PEP8 standards

• Updated docstrings for clarity and consistency

Example Usage: >>> def example_func(a, b): ... return a + b ... >>> sigDTO = read_user_function(example_func)

• Integrate fill_docstring_with_ai (autogeneration for docstrings) with error handling (b68eb96)

• Added auto_generate option to generate_docstring_template to automatically generate docstrings using OpenAI's API.

• Implemented error handling for missing function input (ValueError).

• Ensured PEP 8 compliance with proper indentation, spacing, and docstring format.

Testing

• Add 100% coverage test suite for read_user_function (8b41bae)

• Added comprehensive unit tests for read_user_function, covering:

  • Functions with and without parameters
  • Functions with type hints, default values, and return types
  • Functions using Optional and None type annotations
  • Complex return types such as list[int]
  • Functions executing return statements
  • Error handling for invalid input

• Future improvement: Add checks for src attribute inside the returned object.

• autogen: Achieve 100% test coverage for autogen (fill_docstring_with_ai) (f07d087)

• Added missing test cases to cover all code paths in fill_docstring_with_ai

• Mocked API calls to verify correct request formation and error handling

• Ensured exceptions are raised for invalid inputs and API failures

• Included credit for auto-generated test cases

---

Detailed Changes: v3.0.4...v3.1.0

v3.0.4

v3.0.4 (2025-01-30)

Bug Fixes

• Changed GITHUB TOKEN to PAT => allows use us ruleset (3ec85d3)

---

Detailed Changes: v3.0.3...v3.0.4

v3.0.3

v3.0.3 (2025-01-30)

Bug Fixes

• Quick test semantic release via PR (9871081)

• Quick typo fix for docs (c73f1d6)

• Release token use (3f9e445)

---

Detailed Changes: v3.0.2...v3.0.3

v3.0.2

v3.0.2 (2025-01-30)

Bug Fixes

• Quick typo fix for docs (e4280e7)

---

Detailed Changes: v3.0.1...v3.0.2

v3.0.1

v3.0.1 (2025-01-30)

Bug Fixes

• Add bug feat section to readme addressed by michaels (0ed8f7a)

• Improve readme badges addressed by michaels (2a19a57)

---

Detailed Changes: v3.0.0...v3.0.1

v3.0.0

v3.0.0 (2025-01-29)

Bug Fixes

• Fix readme to have badge for code coverage (6d52fdd)

---

Detailed Changes: v2.0.0...v3.0.0

Minor Release: CD fix

2.0.1

sin-commit: im merging straight to main oh ma lord

v2.0.0

v2.0.0 (2025-01-29)

Features

• Give birth to fml_doc_gen (16251cd)

• Giving birth to fml_doc_gen (5523ea0)

---

Detailed Changes: v1.0.0...v2.0.0