From 4bd48c8a98f6bfeb6920fdae1e8d8e5ab1938b4c Mon Sep 17 00:00:00 2001 From: Khusham Bansal Date: Tue, 25 Mar 2025 16:54:06 +0530 Subject: [PATCH 1/6] Added README.md and requirements.txt --- .gitignore | 1 + README.md | 95 ++++++++++++++++++++++++++++++++++++++++++- requirements.txt | 102 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 197 insertions(+), 1 deletion(-) create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore index 7ee7d43..bbdc5d1 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ _site/ .venv/ /.quarto/ +venv/ diff --git a/README.md b/README.md index 57bd7c3..706b070 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Connecting open science projects -A centralized platform with a searchable database and news feed could greatly improve the discoverability of the open source ecosystem. +A centralized platform with a searchable database and news feed to improve the discoverability of the open source ecosystem. ## Why? @@ -13,3 +13,96 @@ A centralized platform with a searchable database and news feed could greatly im ## Who? Current contributors seeking projects or collaborators, new contributors exploring opportunities, and project leads looking for contributors and partners. + +## Setup Instructions + +### Prerequisites +- Python 3.11 or higher +- Quarto (for rendering the website) - https://quarto.org/docs/get-started/ + +### Installation + +1. Clone this repository: + ``` + git clone https://github.com/OpenScienceLabs/connecting-osp.git + cd connecting-osp + ``` + +2. Create and activate a virtual environment: + ``` + python -m venv venv + source venv/Scripts/activate # On Windows with Git Bash + # OR + venv\Scripts\activate # On Windows with CMD + # OR + .\venv\Scripts\activate # On Windows with PowerShell + ``` + +3. Install the required dependencies: + ``` + pip install -r requirements.txt + ``` + + Note: If you encounter any issues with PyYAML during the Quarto rendering process, make sure it's installed: + ``` + pip install pyyaml + ``` + +### Running the Project + +#### Using Quarto (Recommended) + +With the virtual environment activated: + +``` +quarto preview +``` + +If Quarto is not in your PATH, use the full path to the executable: + +``` +"C:/Program Files/Quarto/bin/quarto.exe" preview # For default installation +``` + +Important notes: +- Make sure your virtual environment is activated when running Quarto +- Quarto will use the Python from your activated environment +- The website will be available at http://localhost:7719/ (or similar port) +- If you see an error about missing 'yaml' module, run `pip install pyyaml` in your activated environment + +#### Using Jupyter Lab (Alternative) + +With the virtual environment activated: + +``` +jupyter lab +``` + +This will open a Jupyter Lab instance in your browser where you can explore and edit the project files. The Jupyter server typically runs at: +- http://localhost:8888/lab (a token will be provided in the terminal output) + +## Project Structure + +- `_quarto.yml` - Quarto configuration file +- `index.qmd` - Homepage +- `projects.qmd` - Projects listing +- `news.qmd` - News feed +- `about.qmd` - About page +- `styles.css` - Custom styles +- `images/` - Image assets +- `data/` - Data files + +## Troubleshooting + +### Common Issues + +1. **"Module not found" errors**: Make sure your virtual environment is activated and all dependencies are installed. + ``` + source venv/Scripts/activate # On Git Bash + pip install -r requirements.txt + ``` + +2. **Quarto not found**: If running `quarto` commands results in "command not found", use the full path to the Quarto executable. + +3. **Missing Python modules during Quarto rendering**: Quarto needs to use the Python from your virtual environment. Make sure to run Quarto commands with your virtual environment activated. + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f674752 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,102 @@ +anyio==4.9.0 +argon2-cffi==23.1.0 +argon2-cffi-bindings==21.2.0 +arrow==1.3.0 +asttokens==3.0.0 +async-lru==2.0.5 +attrs==25.3.0 +babel==2.17.0 +beautifulsoup4==4.13.3 +bleach==6.2.0 +certifi==2025.1.31 +cffi==1.17.1 +charset-normalizer==3.4.1 +colorama==0.4.6 +comm==0.2.2 +debugpy==1.8.13 +decorator==5.2.1 +defusedxml==0.7.1 +executing==2.2.0 +fastjsonschema==2.21.1 +fqdn==1.5.1 +h11==0.14.0 +httpcore==1.0.7 +httpx==0.28.1 +idna==3.10 +ipykernel==6.29.5 +ipython==9.0.2 +ipython_pygments_lexers==1.1.1 +ipywidgets==8.1.5 +isoduration==20.11.0 +jedi==0.19.2 +Jinja2==3.1.6 +json5==0.10.0 +jsonpointer==3.0.0 +jsonschema==4.23.0 +jsonschema-specifications==2024.10.1 +jupyter==1.1.1 +jupyter-console==6.6.3 +jupyter-events==0.12.0 +jupyter-lsp==2.2.5 +jupyter_client==8.6.3 +jupyter_core==5.7.2 +jupyter_server==2.15.0 +jupyter_server_terminals==0.5.3 +jupyterlab==4.3.6 +jupyterlab_pygments==0.3.0 +jupyterlab_server==2.27.3 +jupyterlab_widgets==3.0.13 +MarkupSafe==3.0.2 +matplotlib-inline==0.1.7 +mistune==3.1.3 +nbclient==0.10.2 +nbconvert==7.16.6 +nbformat==5.10.4 +nest-asyncio==1.6.0 +notebook==7.3.3 +notebook_shim==0.2.4 +numpy==2.2.4 +overrides==7.7.0 +packaging==24.2 +pandas==2.2.3 +pandocfilters==1.5.1 +parso==0.8.4 +platformdirs==4.3.7 +prometheus_client==0.21.1 +prompt_toolkit==3.0.50 +psutil==7.0.0 +pure_eval==0.2.3 +pycparser==2.22 +Pygments==2.19.1 +python-dateutil==2.9.0.post0 +python-json-logger==3.3.0 +pytz==2025.1 +pywin32==310 +pywinpty==2.0.15 +PyYAML==6.0.2 +pyzmq==26.3.0 +referencing==0.36.2 +requests==2.32.3 +rfc3339-validator==0.1.4 +rfc3986-validator==0.1.1 +rpds-py==0.23.1 +Send2Trash==1.8.3 +setuptools==78.0.2 +six==1.17.0 +sniffio==1.3.1 +soupsieve==2.6 +stack-data==0.6.3 +terminado==0.18.1 +tinycss2==1.4.0 +tornado==6.4.2 +traitlets==5.14.3 +types-python-dateutil==2.9.0.20241206 +typing_extensions==4.12.2 +tzdata==2025.2 +uri-template==1.3.0 +urllib3==2.3.0 +wcwidth==0.2.13 +webcolors==24.11.1 +webencodings==0.5.1 +websocket-client==1.8.0 +widgetsnbextension==4.0.13 From 75c42e625ff855a074ff44056a4e65893e8a3e81 Mon Sep 17 00:00:00 2001 From: Khusham Bansal <142911972+KhushamBansal@users.noreply.github.com> Date: Wed, 26 Mar 2025 02:46:04 +0530 Subject: [PATCH 2/6] Update README.md Co-authored-by: Anavelyz Perez <42752529+Anavelyz@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 706b070..e78474b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Current contributors seeking projects or collaborators, new contributors explori ### Prerequisites - Python 3.11 or higher -- Quarto (for rendering the website) - https://quarto.org/docs/get-started/ +- Install `uv` ### Installation From d93e1d5d85ed440dac7134618320f00d24b254fc Mon Sep 17 00:00:00 2001 From: Khusham Bansal <142911972+KhushamBansal@users.noreply.github.com> Date: Fri, 28 Mar 2025 19:52:52 +0530 Subject: [PATCH 3/6] Update README.md --- README.md | 48 ++++++++++++++++-------------------------------- 1 file changed, 16 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index e78474b..d97036f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,6 @@ Current contributors seeking projects or collaborators, new contributors explori ### Prerequisites - Python 3.11 or higher -- Install `uv` ### Installation @@ -28,24 +27,17 @@ Current contributors seeking projects or collaborators, new contributors explori cd connecting-osp ``` -2. Create and activate a virtual environment: +2. Create and activate a virtual environment using uv: ``` - python -m venv venv - source venv/Scripts/activate # On Windows with Git Bash + uv venv + source .venv/bin/activate # On Unix or macOS # OR - venv\Scripts\activate # On Windows with CMD - # OR - .\venv\Scripts\activate # On Windows with PowerShell + .venv\Scripts\activate # On Windows ``` -3. Install the required dependencies: - ``` - pip install -r requirements.txt - ``` - - Note: If you encounter any issues with PyYAML during the Quarto rendering process, make sure it's installed: +3. Install the project dependencies: ``` - pip install pyyaml + uv pip install -e . ``` ### Running the Project @@ -58,17 +50,7 @@ With the virtual environment activated: quarto preview ``` -If Quarto is not in your PATH, use the full path to the executable: - -``` -"C:/Program Files/Quarto/bin/quarto.exe" preview # For default installation -``` - -Important notes: -- Make sure your virtual environment is activated when running Quarto -- Quarto will use the Python from your activated environment -- The website will be available at http://localhost:7719/ (or similar port) -- If you see an error about missing 'yaml' module, run `pip install pyyaml` in your activated environment +The website will be available at http://localhost:7719/ (or similar port). #### Using Jupyter Lab (Alternative) @@ -96,13 +78,15 @@ This will open a Jupyter Lab instance in your browser where you can explore and ### Common Issues -1. **"Module not found" errors**: Make sure your virtual environment is activated and all dependencies are installed. +1. **"Module not found" errors**: Make sure your virtual environment is activated and dependencies are installed: ``` - source venv/Scripts/activate # On Git Bash - pip install -r requirements.txt + source .venv/bin/activate # On Unix or macOS + # OR + .venv\Scripts\activate # On Windows + uv pip install -e . ``` -2. **Quarto not found**: If running `quarto` commands results in "command not found", use the full path to the Quarto executable. - -3. **Missing Python modules during Quarto rendering**: Quarto needs to use the Python from your virtual environment. Make sure to run Quarto commands with your virtual environment activated. - +2. **Quarto not found**: The quarto-cli package should install Quarto automatically. If you have issues, try reinstalling the package: + ``` + uv pip install --force-reinstall quarto-cli + ``` From 79ae9babe225c0be92163c76a4bce99084c4f9b3 Mon Sep 17 00:00:00 2001 From: Anavelyz Perez <42752529+Anavelyz@users.noreply.github.com> Date: Wed, 2 Apr 2025 14:47:46 -0400 Subject: [PATCH 4/6] Delete requirements.txt I remove it because we have a pyproject.toml which is sufficient in this case. --- requirements.txt | 102 ----------------------------------------------- 1 file changed, 102 deletions(-) delete mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index f674752..0000000 --- a/requirements.txt +++ /dev/null @@ -1,102 +0,0 @@ -anyio==4.9.0 -argon2-cffi==23.1.0 -argon2-cffi-bindings==21.2.0 -arrow==1.3.0 -asttokens==3.0.0 -async-lru==2.0.5 -attrs==25.3.0 -babel==2.17.0 -beautifulsoup4==4.13.3 -bleach==6.2.0 -certifi==2025.1.31 -cffi==1.17.1 -charset-normalizer==3.4.1 -colorama==0.4.6 -comm==0.2.2 -debugpy==1.8.13 -decorator==5.2.1 -defusedxml==0.7.1 -executing==2.2.0 -fastjsonschema==2.21.1 -fqdn==1.5.1 -h11==0.14.0 -httpcore==1.0.7 -httpx==0.28.1 -idna==3.10 -ipykernel==6.29.5 -ipython==9.0.2 -ipython_pygments_lexers==1.1.1 -ipywidgets==8.1.5 -isoduration==20.11.0 -jedi==0.19.2 -Jinja2==3.1.6 -json5==0.10.0 -jsonpointer==3.0.0 -jsonschema==4.23.0 -jsonschema-specifications==2024.10.1 -jupyter==1.1.1 -jupyter-console==6.6.3 -jupyter-events==0.12.0 -jupyter-lsp==2.2.5 -jupyter_client==8.6.3 -jupyter_core==5.7.2 -jupyter_server==2.15.0 -jupyter_server_terminals==0.5.3 -jupyterlab==4.3.6 -jupyterlab_pygments==0.3.0 -jupyterlab_server==2.27.3 -jupyterlab_widgets==3.0.13 -MarkupSafe==3.0.2 -matplotlib-inline==0.1.7 -mistune==3.1.3 -nbclient==0.10.2 -nbconvert==7.16.6 -nbformat==5.10.4 -nest-asyncio==1.6.0 -notebook==7.3.3 -notebook_shim==0.2.4 -numpy==2.2.4 -overrides==7.7.0 -packaging==24.2 -pandas==2.2.3 -pandocfilters==1.5.1 -parso==0.8.4 -platformdirs==4.3.7 -prometheus_client==0.21.1 -prompt_toolkit==3.0.50 -psutil==7.0.0 -pure_eval==0.2.3 -pycparser==2.22 -Pygments==2.19.1 -python-dateutil==2.9.0.post0 -python-json-logger==3.3.0 -pytz==2025.1 -pywin32==310 -pywinpty==2.0.15 -PyYAML==6.0.2 -pyzmq==26.3.0 -referencing==0.36.2 -requests==2.32.3 -rfc3339-validator==0.1.4 -rfc3986-validator==0.1.1 -rpds-py==0.23.1 -Send2Trash==1.8.3 -setuptools==78.0.2 -six==1.17.0 -sniffio==1.3.1 -soupsieve==2.6 -stack-data==0.6.3 -terminado==0.18.1 -tinycss2==1.4.0 -tornado==6.4.2 -traitlets==5.14.3 -types-python-dateutil==2.9.0.20241206 -typing_extensions==4.12.2 -tzdata==2025.2 -uri-template==1.3.0 -urllib3==2.3.0 -wcwidth==0.2.13 -webcolors==24.11.1 -webencodings==0.5.1 -websocket-client==1.8.0 -widgetsnbextension==4.0.13 From f7141a45bbea6dff042dfb3da0dcdb71cb94b912 Mon Sep 17 00:00:00 2001 From: Khusham Bansal <142911972+KhushamBansal@users.noreply.github.com> Date: Thu, 3 Apr 2025 01:00:12 +0530 Subject: [PATCH 5/6] Update README.md Co-authored-by: Anavelyz Perez <42752529+Anavelyz@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d97036f..04f90b1 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Current contributors seeking projects or collaborators, new contributors explori 3. Install the project dependencies: ``` - uv pip install -e . + uv pip install -r pyproject.toml ``` ### Running the Project From abdc64a177fd6273e57c62e47e159d31bb3a48ae Mon Sep 17 00:00:00 2001 From: Khusham Bansal <142911972+KhushamBansal@users.noreply.github.com> Date: Thu, 3 Apr 2025 01:00:52 +0530 Subject: [PATCH 6/6] Update README.md Co-authored-by: Anavelyz Perez <42752529+Anavelyz@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 04f90b1..89eb8a1 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ This will open a Jupyter Lab instance in your browser where you can explore and source .venv/bin/activate # On Unix or macOS # OR .venv\Scripts\activate # On Windows - uv pip install -e . + uv pip install -r pyproject.toml ``` 2. **Quarto not found**: The quarto-cli package should install Quarto automatically. If you have issues, try reinstalling the package: