Skip to content

added venv in readme #72

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
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ We welcome contributions to OSIPI! To contribute, follow these steps:
- Submit a pull request to the main OSIPI repository.

## Development Setup
### Step 0: Create a Virtual Environment Using your Preferred Method:

We use poetry to manage the dependencies for this project.

### Using Poetry
### 1. Using Poetry
We use poetry to manage the dependencies for this project.

1. If you don't have Poetry installed

Expand All @@ -75,8 +75,6 @@ We use poetry to manage the dependencies for this project.
pip install poetry
```



For more information on installing Poetry, see the [official documentation](https://python-poetry.org/docs/)

2. Clone the repository to your local machine.
Expand All @@ -92,6 +90,35 @@ We use poetry to manage the dependencies for this project.
```bash
poetry shell
```
### 2. Using a Virtual Environment (venv)
If you prefer not to use Poetry, you can create a virtual environment using the built-in `venv` module:

1. Create a virtual environment:

Run the following command in your project directory:
```bash
python -m venv venv
```
2. Activate the virtual environment:
- On Windows:

```bash
.\venv\Scripts\activate
```

- On macOS and Linux:

```bash
source venv/bin/activate
```
3. Install the project dependencies:

Once your virtual environment is active, use pip to install any Python package.
For example, to install numpy, run the following:

```bash
pip install numpy
```

## Setting up pre-commit

Expand Down