Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Core] Add simple serving feature with Uvicorn #10

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

tristandeborde
Copy link
Contributor

In order to make usage of the lib easier from a game engine, add a simple server using Uvicorn.
Single endpoint for now, to update an NPC.


PR Checklist (Click to Expand)

Thank you for your contribution to gigax! Before submitting the pull request, please ensure the PR meets the following criteria. This helps gigax maintain the code quality and improve the efficiency of the review process.

PR Title and Classification

Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

  • [Bugfix] for bug fixes.
  • [CI/Build] for build or continuous integration improvements.
  • [Doc] for documentation fixes and improvements.
  • [Model] for adding a new model or improving an existing model. Model name should appear in the title.
  • [Core] for changes in the core gigax logic
  • [Misc] for PRs that do not fit the above categories. Please use this sparingly.

Note: If the PR spans more than one category, please include all relevant prefixes.

Code Quality

The PR need to meet the following code quality standards:

  • The code needs to be well-documented to ensure future contributors can easily understand the code.
  • Include sufficient tests to ensure the project to stay correct and robust: these should be added to the ./tests folder in the rpo.

Notes for Large Changes

Please keep the changes as concise as possible. For major architectural changes, we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with rfc-required and might not go through the PR.

What to Expect for the Reviews

The goal of the gigax team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the gigax team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:

  • After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
  • After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the gigax team.
  • Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.

Thank You

Finally, thank you for taking the time to read these guidelines and for your interest in contributing to gigax.

@tristandeborde tristandeborde requested a review from A-Mahla June 19, 2024 19:45
@nflan
Copy link

nflan commented Jun 20, 2024

LGTM
Suggestion: add more explanatory comments in app.py to be clearer.

@tristandeborde tristandeborde requested review from nflan and removed request for A-Mahla June 20, 2024 10:03
Copy link

@nflan nflan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Except small explanations, LGTM!

from gigax.step import NPCStepper

load_dotenv()

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Logging configuration

)


logger = logging.getLogger("uvicorn")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
logger = logging.getLogger("uvicorn")


fastapi_logger.handlers = logging.getLogger("gunicorn.error").handlers
logging.basicConfig(level=logging.INFO, handlers=[logging.StreamHandler(sys.stdout)])

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
logger = logging.getLogger("uvicorn")



logger = logging.getLogger("uvicorn")
logging.basicConfig(level=logging.INFO)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure that we need this line that is similar to the line 25?



logger = logging.getLogger("uvicorn")
logging.basicConfig(level=logging.INFO)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
logging.basicConfig(level=logging.INFO)

logger = logging.getLogger("uvicorn")
logging.basicConfig(level=logging.INFO)


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Exception handler for validation errors

content=content, status_code=status.HTTP_422_UNPROCESSABLE_ENTITY
)


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Request model

items: list[Item]
events: list[CharacterAction]


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Endpoint for stepping the character

events=request.events,
)


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Health check endpoint

async def health_check():
return {"status": "ok"}


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Run Uvicorn server

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants