Skip to content
Open
Show file tree
Hide file tree
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
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,27 @@ Current contributors seeking projects or collaborators, new contributors explori
uv pip install -r pyproject.toml
```


#### Alternative: Using Standard Python venv + pip (Optional)

If you prefer to use standard Python tools without `uv`, you can install the project using `venv` and `pip`:

1. Create and activate a virtual environment using Python:

```bash
python3 -m venv .venv
source .venv/bin/activate # On Unix or macOS
# OR
.venv\Scripts\activate # On Windows
```

2. Install the project in editable mode:

```bash
pip install -e .
```

Both installation methods work side-by-side, so you can choose whichever is more convenient for your development setup.
### Running the Project

#### Using Quarto (Recommended)
Expand Down
12 changes: 11 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
[project]
name = "connecting-osp"
version = "0.1.0"
description = "Add your description here"
description = "A centralized platform with a searchable database and news feed to improve the discoverability of the open source ecosystem."
readme = "README.md"
requires-python = ">=3.11"
dependencies = [
"jupyterlab>=4.3.6",
"pandas>=2.2.3",
"quarto-cli>=1.6.42",
]

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
packages = []

[tool.setuptools.package-data]
"*" = ["*.csv", "*.json", "*.yml", "*.yaml"]