diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..68a9e1ff4 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- v0.2 agents platform diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index b3ca326de..1e4e8634c 100644 --- a/README.md +++ b/README.md @@ -1,46 +1 @@ -## julep.ai monorepo - -### Workflow for local dev - -- Create required `.env` files -- `docker compose up -d` to start the service in the background -- `docker compose watch` to auto rebuild services when files are updated -- `docker compose logs -f {service_name}... ` to watch logs - -### Workflow for autogenerated stuff - -#### spec flow: -- author agents openapi spec (on apigit) -- convert to yaml and save in the root of monorepo -- openai's swagger spec is used directly for model api spec - -#### sdk generate flow: -- fern uses the same openapi spec -- run fern generate -- the generated files are not formatted correctly so run formatters: - + `npx prettier -w src` for js sdk - + `poetry run black .` for python sdk - -#### agents-api flow: -- uses the openapi.yaml file in root for generating req/resp types -- uses datamodel-code-generator -- run `poe codegen` to use it -- it's not perfect, needs minor modifications to the generated code - -#### python sdk testing: -- uses prism for mocking the openapi server -- unfortunately, it doesn't support adding a custom prefix at this time -- so you need to copy `openapi.yaml` from root to `sdks/python/tests/mock_openapi.yaml` -- and then edit all endpoints to add prefix `/api/` - -#### python sdk docs: -- from the custom + autogenerated code -- uses handsdown -- run `poe doc` -- it'll render markdown inside the gitbook/ directory in root - -#### js sdk docs: -- uses typedoc -- run `npm run docs` - -[agents openapi spec](https://github.com/julep-ai/monorepo/blob/main/openapi.yaml) +# julep.ai diff --git a/agents-api/agents_api/env.py b/agents-api/agents_api/env.py index a00211ee7..7c3b961c0 100644 --- a/agents-api/agents_api/env.py +++ b/agents-api/agents_api/env.py @@ -1,11 +1,19 @@ +""" +This module is responsible for loading and providing access to environment variables used throughout the agents-api application. +It utilizes the environs library for environment variable parsing. +""" from pprint import pprint from environs import Env +# Initialize the Env object for environment variable parsing. env = Env() env.read_env() +# Debug mode +debug: bool = env.bool("AGENTS_API_DEBUG", default=False) +# Base URL for the COZO service. Defaults to the local development URL if not specified. cozo_host: str = env.str("COZO_HOST", default="http://127.0.0.1:9070") cozo_auth: str = env.str("COZO_AUTH_TOKEN", default=None) prediction_project: str = env.str("PREDICTION_PROJECT", default=None) @@ -50,7 +58,9 @@ temporal_client_cert: str = env.str("TEMPORAL_CLIENT_CERT", default=None) temporal_private_key: str = env.str("TEMPORAL_PRIVATE_KEY", default=None) +# Consolidate environment variables into a dictionary for easy access and debugging. environment = dict( + debug=debug, cozo_host=cozo_host, cozo_auth=cozo_auth, generation_url=generation_url, @@ -70,6 +80,8 @@ temporal_namespace=temporal_namespace, ) -print("Environment variables:") -pprint(environment) -print() +if debug: + # Print the loaded environment variables for debugging purposes. + print("Environment variables:") + pprint(environment) + print() diff --git a/agents-api/agents_api/web.py b/agents-api/agents_api/web.py index d3a791b48..265e69657 100644 --- a/agents-api/agents_api/web.py +++ b/agents-api/agents_api/web.py @@ -1,3 +1,6 @@ +""" +This module initializes the FastAPI application, registers routes, sets up middleware, and configures exception handlers. +""" import fire import uvicorn import logging @@ -34,6 +37,15 @@ def make_exception_handler(status: int): + """ + Creates a custom exception handler for the application. + + Parameters: + - status (int): The HTTP status code to return for this exception. + + Returns: + A callable exception handler that logs the exception and returns a JSON response with the specified status code. + """ async def _handler(request: Request, exc): exc_str = f"{exc}".replace("\n", " ").replace(" ", " ") logger.exception(exc) @@ -44,6 +56,12 @@ async def _handler(request: Request, exc): def register_exceptions(app: FastAPI): + """ + Registers custom exception handlers for the FastAPI application. + + Parameters: + - app (FastAPI): The FastAPI application instance to register the exception handlers for. + """ app.add_exception_handler( RequestValidationError, make_exception_handler(status.HTTP_422_UNPROCESSABLE_ENTITY), @@ -110,5 +128,6 @@ def main( ) +# Check if the script is being run directly and, if so, start the Uvicorn server with the specified configuration. if __name__ == "__main__": fire.Fire(main)