PR-Pilot-AI / jira-integration

GNU General Public License v3.0
1 stars 0 forks source link

πŸš€ Initialize Project with Python and FastAPI #2

Open arcane-engine[bot] opened 4 months ago

arcane-engine[bot] commented 4 months ago

To initialize the project with Python and FastAPI, follow these steps:

  1. Set up a virtual environment:

    • Run python3 -m venv venv to create a virtual environment.
    • Activate the virtual environment with source venv/bin/activate (Linux/Mac) or venv\Scripts\activate (Windows).
  2. Install FastAPI and Uvicorn:

    • Install FastAPI with pip install fastapi.
    • Install Uvicorn, an ASGI server, with pip install uvicorn.
  3. Create initial project files:

    • main.py: This will be the entry point of your application.
    • requirements.txt: List all the project dependencies here.
  4. Develop the API endpoint:

    • In main.py, import FastAPI and create an instance of it.
    • Define an endpoint that listens for POST requests. This endpoint will handle the JIRA webhook.
  5. Run the application:

    • Use the command uvicorn main:app --reload to run the application. Ensure app is the instance name of your FastAPI application in main.py.
  6. Test the application:

    • Use tools like Postman or curl to test the POST endpoint.

This issue will serve as a starting point for the project. Further refinement and detailed planning of the API endpoint that handles the JIRA webhook will be needed.

mlamina commented 4 months ago

/pilot create the files and implement as much of the endpoint so that the information from the JIRA webhook payload is parsed into variables for me to use

arcane-engine[bot] commented 4 months ago

I've created the initial project files as requested:

  1. requirements.txt - Contains the dependencies for the project, including FastAPI and Uvicorn.
  2. main.py - Includes a basic FastAPI setup with an endpoint /webhook/jira designed to handle POST requests from JIRA webhooks. This endpoint parses the JIRA webhook payload into variables: issue_key, issue_summary, and issue_status, which you can use for further processing.

You can now proceed with testing and further development of the application.

PR: πŸš€ Initial project setup with FastAPI and JIRA webhook endpoint

If you require further changes, continue our conversation over there!


πŸ“‹ Log ↩️ Undo