Tofupilot

Added

- Centralized all constant values in a dedicated `/constants` folder
- Introduced sending of metadata containing package type and version when communicating with TofuPilot API
- Implemented logging of any warning received from API

Fixed

- Corrected an issue where an exception was risen before user was informed that their API key was incorrect

Changed

- Enhanced the logging and error messages related to attachments and run creation
- Updated the success message handling to now be received directly from the API, rather than being computed by the client
- Reorganized the README.md by swapping the Documentation and Examples sections
- Updated links in README.md from relative to absolute, ensuring they work correctly across all contexts where the documentation is viewed

Removed

- `raw_response` property in responses sent by client
- Checking of file format during attachment upload (to keep only size checking)

Fixed

- `steps` parameter was required in client.create_run method

Added

- `steps` parameter in client.create_run method to reflect TofuPilot's API update

Added

- LICENSE.md file
- CONTRIBUTING.md file
- CODE_OF_CONDUCT.md file
- Unitary tests in new tests/ folder
- Functional tests in new examples/ folder
- Docstring for the client’s create_run method
- Github action for automatic testing
- Github action for automatic release in Pypi

Fixed

- Replaced deprecated package pkg_resources with a maintained alternative

Changed

- Open-sourced the repository
- Made API key readable from environment
- Detailed the project in README.md
- Standardized and enhanced logging output for better readability

Changed

- renamed "params" to "report_variables"

Changed

- Made the “duration” parameter of the client optional to match the API
- Made the client.create_run method return an object containing only the run URL, not its ID