feat: update readme and contribution files

Author: manisha841

README.md

@@ -67,12 +67,14 @@ scode	cscode	pref	reason
 ```
 
 ## Command
+You need to have [Rye](https://rye-up.com/guide/installation/) installed in your system to be able to run the project.Once you have it installed, run ```rye sync```
 
 To run `school_center.py` use the command below:
 
 ```bash
-rye run python -m school_center sample_data/schools_grade12_2081.tsv sample_data/centers_grade12_2081.tsv sample_data/prefs.tsv
+rye run dev
 ```
+If you change the location of your sample files, make sure to update the command(cmd) in ```[tool.rye.scripts]``` in the ```pyproject.toml``` file with your file path and execute ```rye sync``` . If you wish to run any other files than ```school_center.py```, you can simply do ```rye run python file_name.py```
 
 ## Output
 

pyproject.toml

@@ -28,6 +28,9 @@ dev-dependencies = [
     "pre-commit==3.6.0",
 ]
 
+[tool.rye.scripts]
+dev = { cmd = "python -m school_center sample_data/schools_grade12_2081.tsv sample_data/centers_grade12_2081.tsv sample_data/prefs.tsv", env = {} }
+
 [tool.hatch.metadata]
 allow-direct-references = true
 

requirements-dev.lock

@@ -13,7 +13,7 @@ altair==5.3.0
 attrs==23.2.0
     # via jsonschema
     # via referencing
-blinker==1.8.0
+blinker==1.8.1
     # via streamlit
 branca==0.7.2
     # via folium
@@ -35,7 +35,7 @@ coverage==7.5.0
     # via pytest-cov
 distlib==0.3.8
     # via virtualenv
-filelock==3.13.4
+filelock==3.14.0
     # via virtualenv
 folium==0.16.0
     # via center-randomize
@@ -56,7 +56,7 @@ jinja2==3.1.3
     # via folium
     # via pydeck
     # via streamlit-folium
-jsonschema==4.21.1
+jsonschema==4.22.0
     # via altair
 jsonschema-specifications==2023.12.1
     # via jsonschema
@@ -96,9 +96,9 @@ protobuf==4.25.3
     # via streamlit
 pyarrow==16.0.0
     # via streamlit
-pydeck==0.8.0
+pydeck==0.9.0
     # via streamlit
-pygments==2.17.2
+pygments==2.18.0
     # via rich
 pytest==8.0.2
     # via pytest-clarity
@@ -113,7 +113,7 @@ pytz==2024.1
     # via pandas
 pyyaml==6.0.1
     # via pre-commit
-referencing==0.35.0
+referencing==0.35.1
     # via jsonschema
     # via jsonschema-specifications
 requests==2.31.0
@@ -132,7 +132,7 @@ six==1.16.0
     # via python-dateutil
 smmap==5.0.1
     # via gitdb
-streamlit==1.33.0
+streamlit==1.34.0
     # via center-randomize
     # via streamlit-folium
 streamlit-folium==0.19.1
@@ -153,7 +153,7 @@ tzdata==2024.1
     # via pandas
 urllib3==2.2.1
     # via requests
-virtualenv==20.26.0
+virtualenv==20.26.1
     # via pre-commit
 watchdog==4.0.0
     # via streamlit

requirements.lock

@@ -13,7 +13,7 @@ altair==5.3.0
 attrs==23.2.0
     # via jsonschema
     # via referencing
-blinker==1.8.0
+blinker==1.8.1
     # via streamlit
 branca==0.7.2
     # via folium
@@ -43,7 +43,7 @@ jinja2==3.1.3
     # via folium
     # via pydeck
     # via streamlit-folium
-jsonschema==4.21.1
+jsonschema==4.22.0
     # via altair
 jsonschema-specifications==2023.12.1
     # via jsonschema
@@ -72,15 +72,15 @@ protobuf==4.25.3
     # via streamlit
 pyarrow==16.0.0
     # via streamlit
-pydeck==0.8.0
+pydeck==0.9.0
     # via streamlit
-pygments==2.17.2
+pygments==2.18.0
     # via rich
 python-dateutil==2.9.0.post0
     # via pandas
 pytz==2024.1
     # via pandas
-referencing==0.35.0
+referencing==0.35.1
     # via jsonschema
     # via jsonschema-specifications
 requests==2.31.0
@@ -95,7 +95,7 @@ six==1.16.0
     # via python-dateutil
 smmap==5.0.1
     # via gitdb
-streamlit==1.33.0
+streamlit==1.34.0
     # via center-randomize
     # via streamlit-folium
 streamlit-folium==0.19.1