wip: update readme and added necessary dependencies

manisha841 · manisha841 · commit 926115b7cd89 · 2024-04-28T10:21:17.000+05:45
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
@@ -19,10 +19,11 @@ Thank you for considering contributing to our project! We welcome contributions
 
 1. Fork and clone the Repository
 2. Pull latest changes from the main repository if it has diverged
-3. [Create a virtual environment for the project](https://docs.python.org/3/library/venv.html)
-4. Install dependencies using `pip install -r requirements.txt`
-5. Install pre-commit hook using `pre-commit install`
-6. Run tests using `pytest tests/test_file_name.py ` or specific test name like `pytest tests/test_file_name.py::test_function_name`
+3. Add Rye on your system if it is not installed already. [Source](https://rye-up.com/guide/installation/)
+4. Install all the dependencies using `rye sync`.
+5. Install pre-commit hook using `rye run pre-commit install`
+6. Run `rye add package_name` (if you wish to add any packages as per your requirements.)
+6. Run tests using `rye run pytest` or `rye run pytest -k test_function_name -v` to run specific file.
 7. Do not push changes without the tests and coverage passing
 8. Commit your changes with **proper** commit messages in imperative form like `Add my best feature`, `Fix issues casusing whatever`, `Update docs` etc: [Good reference here](https://cbea.ms/git-commit/)
 9. Make changes and push to your forked repository
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ scode	cscode	pref	reason
 To run `school_center.py` use the command below:
 
 ```bash
-python3 school_center.py sample_data/schools_grade12_2081.tsv sample_data/centers_grade12_2081.tsv sample_data/prefs.tsv
+rye run python -m school_center sample_data/schools_grade12_2081.tsv sample_data/centers_grade12_2081.tsv sample_data/prefs.tsv
 ```
 
 ## Output
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,6 +6,9 @@ authors = [
     { name = "Manisha Bhandari", email = "manishabhandari841@gmail.com" }
 ]
 dependencies = [
+    "streamlit==1.33.0",
+    "streamlit-folium==0.19.1",
+    "folium==0.16.0",
 ]
 readme = "README.md"
 requires-python = ">= 3.12"
diff --git a/requirements-dev.lock b/requirements-dev.lock
@@ -8,36 +8,96 @@
 #   with-sources: false
 
 -e file:.
+altair==5.3.0
+    # via streamlit
+attrs==23.2.0
+    # via jsonschema
+    # via referencing
+blinker==1.8.0
+    # via streamlit
+branca==0.7.2
+    # via folium
+    # via streamlit-folium
+cachetools==5.3.3
+    # via streamlit
+certifi==2024.2.2
+    # via requests
 cfgv==3.4.0
     # via pre-commit
+charset-normalizer==3.3.2
+    # via requests
+click==8.1.7
+    # via streamlit
 colorama==0.4.6
+    # via click
     # via pytest
 coverage==7.5.0
     # via pytest-cov
 distlib==0.3.8
     # via virtualenv
 filelock==3.13.4
     # via virtualenv
+folium==0.16.0
+    # via center-randomize
+    # via streamlit-folium
+gitdb==4.0.11
+    # via gitpython
+gitpython==3.1.43
+    # via streamlit
 identify==2.5.36
     # via pre-commit
+idna==3.7
+    # via requests
 iniconfig==2.0.0
     # via pytest
+jinja2==3.1.3
+    # via altair
+    # via branca
+    # via folium
+    # via pydeck
+    # via streamlit-folium
+jsonschema==4.21.1
+    # via altair
+jsonschema-specifications==2023.12.1
+    # via jsonschema
 markdown-it-py==3.0.0
     # via rich
+markupsafe==2.1.5
+    # via jinja2
 mdurl==0.1.2
     # via markdown-it-py
 nodeenv==1.8.0
     # via pre-commit
+numpy==1.26.4
+    # via altair
+    # via folium
+    # via pandas
+    # via pyarrow
+    # via pydeck
+    # via streamlit
 packaging==24.0
+    # via altair
     # via pytest
     # via pytest-sugar
+    # via streamlit
+pandas==2.2.2
+    # via altair
+    # via streamlit
+pillow==10.3.0
+    # via streamlit
 platformdirs==4.2.1
     # via virtualenv
 pluggy==1.5.0
     # via pytest
 pprintpp==0.4.0
     # via pytest-clarity
 pre-commit==3.6.0
+protobuf==4.25.3
+    # via streamlit
+pyarrow==16.0.0
+    # via streamlit
+pydeck==0.8.0
+    # via streamlit
 pygments==2.17.2
     # via rich
 pytest==8.0.2
@@ -47,14 +107,55 @@ pytest==8.0.2
 pytest-clarity==1.0.1
 pytest-cov==5.0.0
 pytest-sugar==1.0.0
+python-dateutil==2.9.0.post0
+    # via pandas
+pytz==2024.1
+    # via pandas
 pyyaml==6.0.1
     # via pre-commit
+referencing==0.35.0
+    # via jsonschema
+    # via jsonschema-specifications
+requests==2.31.0
+    # via folium
+    # via streamlit
 rich==13.7.1
     # via pytest-clarity
+    # via streamlit
+rpds-py==0.18.0
+    # via jsonschema
+    # via referencing
 ruff==0.4.1
 setuptools==69.5.1
     # via nodeenv
+six==1.16.0
+    # via python-dateutil
+smmap==5.0.1
+    # via gitdb
+streamlit==1.33.0
+    # via center-randomize
+    # via streamlit-folium
+streamlit-folium==0.19.1
+    # via center-randomize
+tenacity==8.2.3
+    # via streamlit
 termcolor==2.4.0
     # via pytest-sugar
+toml==0.10.2
+    # via streamlit
+toolz==0.12.1
+    # via altair
+tornado==6.4
+    # via streamlit
+typing-extensions==4.11.0
+    # via streamlit
+tzdata==2024.1
+    # via pandas
+urllib3==2.2.1
+    # via requests
 virtualenv==20.26.0
     # via pre-commit
+watchdog==4.0.0
+    # via streamlit
+xyzservices==2024.4.0
+    # via folium
diff --git a/requirements.lock b/requirements.lock
@@ -8,3 +8,113 @@
 #   with-sources: false
 
 -e file:.
+altair==5.3.0
+    # via streamlit
+attrs==23.2.0
+    # via jsonschema
+    # via referencing
+blinker==1.8.0
+    # via streamlit
+branca==0.7.2
+    # via folium
+    # via streamlit-folium
+cachetools==5.3.3
+    # via streamlit
+certifi==2024.2.2
+    # via requests
+charset-normalizer==3.3.2
+    # via requests
+click==8.1.7
+    # via streamlit
+colorama==0.4.6
+    # via click
+folium==0.16.0
+    # via center-randomize
+    # via streamlit-folium
+gitdb==4.0.11
+    # via gitpython
+gitpython==3.1.43
+    # via streamlit
+idna==3.7
+    # via requests
+jinja2==3.1.3
+    # via altair
+    # via branca
+    # via folium
+    # via pydeck
+    # via streamlit-folium
+jsonschema==4.21.1
+    # via altair
+jsonschema-specifications==2023.12.1
+    # via jsonschema
+markdown-it-py==3.0.0
+    # via rich
+markupsafe==2.1.5
+    # via jinja2
+mdurl==0.1.2
+    # via markdown-it-py
+numpy==1.26.4
+    # via altair
+    # via folium
+    # via pandas
+    # via pyarrow
+    # via pydeck
+    # via streamlit
+packaging==24.0
+    # via altair
+    # via streamlit
+pandas==2.2.2
+    # via altair
+    # via streamlit
+pillow==10.3.0
+    # via streamlit
+protobuf==4.25.3
+    # via streamlit
+pyarrow==16.0.0
+    # via streamlit
+pydeck==0.8.0
+    # via streamlit
+pygments==2.17.2
+    # via rich
+python-dateutil==2.9.0.post0
+    # via pandas
+pytz==2024.1
+    # via pandas
+referencing==0.35.0
+    # via jsonschema
+    # via jsonschema-specifications
+requests==2.31.0
+    # via folium
+    # via streamlit
+rich==13.7.1
+    # via streamlit
+rpds-py==0.18.0
+    # via jsonschema
+    # via referencing
+six==1.16.0
+    # via python-dateutil
+smmap==5.0.1
+    # via gitdb
+streamlit==1.33.0
+    # via center-randomize
+    # via streamlit-folium
+streamlit-folium==0.19.1
+    # via center-randomize
+tenacity==8.2.3
+    # via streamlit
+toml==0.10.2
+    # via streamlit
+toolz==0.12.1
+    # via altair
+tornado==6.4
+    # via streamlit
+typing-extensions==4.11.0
+    # via streamlit
+tzdata==2024.1
+    # via pandas
+urllib3==2.2.1
+    # via requests
+watchdog==4.0.0
+    # via streamlit
+xyzservices==2024.4.0
+    # via folium
diff --git a/test_requirements.txt b/test_requirements.txt

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@ authors = [`
`6`	`6`	`{ name = "Manisha Bhandari", email = "[email protected]" }`
`7`	`7`	`]`
`8`	`8`	`dependencies = [`
	`9`	`+ "streamlit==1.33.0",`
	`10`	`+ "streamlit-folium==0.19.1",`
	`11`	`+ "folium==0.16.0",`
`9`	`12`	`]`
`10`	`13`	`readme = "README.md"`
`11`	`14`	`requires-python = ">= 3.12"`