diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d354774 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,77 @@ + +# Potpie Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at dhiren@potpie.ai All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md new file mode 100644 index 0000000..1297a9b --- /dev/null +++ b/GETTING_STARTED.md @@ -0,0 +1,149 @@ +# Firebase Setup +To set up Firebase, follow these steps: +1. **Create a Firebase Project**: Go to [Firebase Console](https://console.firebase.google.com/) and create a new project. +2. **Generate a Service Account Key**: + - Click on **Project Overview** from the sidebar. + - Open the **Service Accounts** tab. + - Click on the option to generate a new private key in the Firebase Admin SDK sub-section. + - Read the warning and generate the key. Rename the downloaded key to `firebase_service_account.json` and move it to the root of the potpie source code. +--- +# Portkey Integration +Portkey provides observability and monitoring capabilities for AI integration with Potpie. +- **Sign Up**: Create a free account at [Portkey](https://app.portkey.ai/signup) and keep your API key in .env as PORTKEY_API_KEY. +--- +# Setting Up GitHub App +To enable login via GitHub, create a GitHub app by following these steps: +1. Visit [GitHub App Creation](https://github.com/settings/apps/new). +2. **Name Your App**: Choose a name relevant to Potpie (e.g., `potpie-auth`). +3. **Set Permissions**: + - **Repository Permissions**: + - Contents: Read Only + - Metadata: Read Only + - Pull Requests: Read and Write + - Secrets: Read Only + - Webhook: Read Only + - **Organization Permissions**: Members : Read Only + - **Account Permissions**: Email Address: Read Only +4. **Generate a Private Key**: Download the private key and add it to env under `GITHUB_PRIVATE_KEY`. Add your app ID to `GITHUB_APP_ID`. +5. **Install the App**: From the left sidebar, select **Install App** and install it next to your organization/user account. +--- +# Enabling GitHub Auth on Firebase +1. Open Firebase and navigate to **Authentication**. +2. Enable GitHub sign-in capability by adding a GitHub OAuth app from your account. This will provide you with a client secret and client ID to add to Firebase. +3. Copy the callback URL from Firebase and add it to your GitHub app. +GitHub Auth with Firebase is now ready. +--- +# Google Cloud Setup +Potpie uses Google Secret Manager to securely manage API keys. If you created a Firebase app, a linked Google Cloud account will be automatically created. You can use that or create a new one as needed. +Follow these steps to set up the Secret Manager and Application Default Credentials (ADC) for Potpie: +1. Set up the Secret Manager. +2. Configure Application Default Credentials for local use. +Once completed, you are ready to proceed with the Potpie setup. +--- +# Running Potpie +1. **Ensure Docker is Installed**: Verify that Docker is installed and running on your system. +2. **Set Up the Environment**: Create a `.env` file based on the provided `.env.template` in the repository. This file should include all necessary configuration settings for the application. +3. **Google Cloud Authentication**: Log in to your Google Cloud account and set up Application Default Credentials (ADC). Detailed instructions can be found in the documentation. Alternatively place the service account key file for your gcp project in service-account.json file in the root of the codebase. +5. **Run Potpie**: Execute the following command: + ```bash + ./start.sh + ``` + You may need to make it executable by running: + ```bash + chmod +x start.sh + ``` + +# API Workflow Guide +## Prerequisites +1. Ensure the API server is running and accessible at `http://localhost:8001`. +2. Have `curl` installed on your machine to execute the API requests. +## Step 1: Logging in to get a bearer token +```bash +curl -X 'POST' \ + 'http://localhost:8001/api/v1/login' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{ + "email": "string", + "password": "string" +}' +``` +## Step 2: Submit a Parsing Request +Replace the repo name and branch name with the repo you want to talk to. +```bash +curl -X 'POST' \ + 'http://localhost:8001/api/v1/parse' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{ + "repo_name": "vineetshar/mongo-proxy12", + "branch_name": "main" +}' +``` +## Step 3: Check Parsing Status +Use the project id generated from previous request. +```bash +curl -X 'GET' \ + 'http://localhost:8001/api/v1/parsing-status/project-id' \ + -H 'accept: application/json' +``` +## Step 4: List Available Agents +```bash +curl -X 'GET' \ + 'http://localhost:8001/api/v1/list-available-agents/?list_system_agents=true' \ + -H 'accept: application/json' +``` +## Step 5: Create a Conversation +```bash +curl -X 'POST' \ + 'http://localhost:8001/api/v1/conversations/' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{ + "user_id": "your_user_id", + "title": "Conversation Title", + "status": "active", + "project_ids": [ + "project_id" + ], + "agent_ids": [ + "agent_id" + ] +}' +``` +## Step 6: Send Messages in a Conversation + +This API returns a stream response for the +```bash +curl -X 'POST' \ + 'http://localhost:8001/api/v1/conversations/1234/message/' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{ + "content": "Your message content here", + "node_ids": [ + { + "node_id": "node_identifier", + "name": "node_name" + } + ] +}' +``` +## Step 7: Get all the messages of a conversation +```bash +curl -X 'GET' \ + 'http://localhost:8001/api/v1/conversations/conversation-id/ + messages/?start=0&limit=10' \ + -H 'accept: application/json' +``` +## Additional Information +For more details on additional API endpoints and comprehensive documentation, visit [docs.potpie.ai](https://docs.potpie.ai) +## Summary +1. Submit a Parsing Request: Initiate parsing of a repository. +2. Check Parsing Status: Monitor the progress until parsing is complete. +3. List Available Agents: Retrieve agents to interact with. +4. Create a Conversation: Start a new conversation session. +5. Send Messages: Communicate within the created conversation. + + + diff --git a/readme.md b/readme.md index ff653d0..188f97a 100644 --- a/readme.md +++ b/readme.md @@ -10,6 +10,8 @@ Potpie also provides purpose built agents that are expert on your codebase to pe - [What Makes Potpie Agents Unique?](#what-makes-potpie-agents-unique) - [Potpie's Tooling System](#potpie's-tooling-system) - [The Power of Custom Agents](#the-power-of-custom-agents-coming-soon) +- [Getting Started](#getting-started) +- [Make Potpie Your Own](#make-potpie-your-own) - [Contributing](#contributing) - [License](#license) @@ -66,6 +68,10 @@ Potpie’s cloud platform supports **Custom Agents**, enabling you to create age - Identifying and reporting security vulnerabilities in the codebase. - Automatically generating unit tests based on existing code logic. +--- +## Getting Started + +Refer to the [Getting Started Guide](./GETTING_STARTED.md) for detailed instructions on setting up Potpie and making your first agent work for you! --- ## Make Potpie Your Own