Skip to content

Docs: Improve installation section and add troubleshooting guide #697

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

HariharanBalakrishnan22
Copy link

@HariharanBalakrishnan22 HariharanBalakrishnan22 commented Apr 22, 2025


name: Pull Request
about: Create a pull request to contribute to the project
title: 'Docs: Improve installation section and add troubleshooting guide'
labels: ''
assignees: ''

Related Issue
Fixes #(issue)

Description of Changes

  • Added clarification in the Installation section about Python 3.7+ requirement
  • Suggested running pip install --upgrade pip if users face installation issues
  • Added a Troubleshooting guide for "Port already in use" error when running Preswald locally

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • New example
  • Test improvement

Testing
-No code changes involved.
-Reviewed the README.md formatting on local machine to ensure clean layout.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have run my code against examples and ensured no errors
  • Any dependent changes have been merged and published in downstream modules

@amrutha97 amrutha97 force-pushed the main branch 2 times, most recently from 6ac1dad to bdb2c4e Compare April 24, 2025 07:54
Copy link
Member

@shivam-singhal shivam-singhal left a comment

Choose a reason for hiding this comment

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

Great PR, can you address the change and then i can merge

## **Installation**

First, install Preswald using pip. https://pypi.org/project/preswald/
First, install Preswald using pip (requires Python 3.7+)
Copy link
Member

Choose a reason for hiding this comment

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

*3.10, not 3.7

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.

2 participants