From e3070353250b508f830a393f144381a9869df7b7 Mon Sep 17 00:00:00 2001 From: Conor O'Callaghan <4090256+Conor0Callaghan@users.noreply.github.com> Date: Tue, 3 Dec 2024 11:50:11 +0000 Subject: [PATCH 1/4] #208 Updating readme to add badge Add badge to README as per #208 part 1 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a7e3ede..8b72fa3 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ ![Build Status](https://img.shields.io/github/actions/workflow/status/pittcsc/PittAPI/autotest.yml?branch=dev) ![License](https://img.shields.io/badge/license-GPLv2-blue.svg) ![Python Version](https://img.shields.io/badge/python-%3E%3D%203.9-green.svg) +![Pypi Version](https://img.shields.io/pypi/v/pittapi.svg) The Pitt API is an unofficial Python API made by Ritwik Gupta at the University of Pittsburgh in an effort to get more open data from Pitt. From de6bca803ac5af3e4798031db793582206e2eafe Mon Sep 17 00:00:00 2001 From: Conor O'Callaghan <4090256+Conor0Callaghan@users.noreply.github.com> Date: Mon, 9 Dec 2024 14:55:08 +0000 Subject: [PATCH 2/4] Update README.md Updating Readme with first attempt at additional install commands as per comments in #208 --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8b72fa3..77d28ef 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,18 @@ ![Build Status](https://img.shields.io/github/actions/workflow/status/pittcsc/PittAPI/autotest.yml?branch=dev) ![License](https://img.shields.io/badge/license-GPLv2-blue.svg) ![Python Version](https://img.shields.io/badge/python-%3E%3D%203.9-green.svg) -![Pypi Version](https://img.shields.io/pypi/v/pittapi.svg) +[![Pypi Version](https://img.shields.io/pypi/v/pittapi.svg)](https://pypi.org/project/PittAPI/) The Pitt API is an unofficial Python API made by Ritwik Gupta at the University of Pittsburgh in an effort to get more open data from Pitt. +## Installation + +Pitt API can be installed using the python package manager ``pip``. To make your development easier, you can run the pip commands in a virtual environment. + +1. Install ``pipenv`` using the [instructions](https://pipenv.pypa.io/en/latest/installation.html) for your operating system, pipenv is a tool which manages your python virtual environments for you. +2. Run the commands ``pipenv install`` and ``pipenv shell`` to create and setup the virtual environment. +3. Install the PittAPI in the new virtual environment ``pip install PittAPI``, see the usage guide below for further information. + ## Usage examples ```python @@ -59,11 +67,6 @@ medium_dict = dining.get_locations() hours = dining.get_location_hours("The Eatery", datetime.datetime(2024, 4, 12)) ``` -## Local Setup -Install Python 3.12 and ``pipenv``. - -Run ``pipenv install`` and ``pipenv shell`` to create and setup the virtual environment. - ## Contributing Read our [contributing guidelines](/CONTRIBUTING.md) to learn how to contribute to the Pitt API. From 4be255d4d9b96a9dea89a27720b1abdc45aaaf1e Mon Sep 17 00:00:00 2001 From: Alex Zharichenko Date: Mon, 23 Dec 2024 10:51:34 -0500 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 77d28ef..04f6db3 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The Pitt API is an unofficial Python API made by Ritwik Gupta at the University Pitt API can be installed using the python package manager ``pip``. To make your development easier, you can run the pip commands in a virtual environment. 1. Install ``pipenv`` using the [instructions](https://pipenv.pypa.io/en/latest/installation.html) for your operating system, pipenv is a tool which manages your python virtual environments for you. -2. Run the commands ``pipenv install`` and ``pipenv shell`` to create and setup the virtual environment. +2. Run the commands ``pipenv sync --dev`` and ``pipenv shell`` to create and setup the virtual environment. 3. Install the PittAPI in the new virtual environment ``pip install PittAPI``, see the usage guide below for further information. ## Usage examples From 41ac4b1991be6abba4a96c68b32e576b8a0bb2de Mon Sep 17 00:00:00 2001 From: Alex Zharichenko Date: Mon, 23 Dec 2024 10:51:40 -0500 Subject: [PATCH 4/4] Update README.md Co-authored-by: Tianyi Zheng --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 04f6db3..1c61cee 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The Pitt API is an unofficial Python API made by Ritwik Gupta at the University ## Installation -Pitt API can be installed using the python package manager ``pip``. To make your development easier, you can run the pip commands in a virtual environment. +The Pitt API can be installed using the Python package manager `pip`. To make your development easier, you can run the pip commands in a virtual environment. 1. Install ``pipenv`` using the [instructions](https://pipenv.pypa.io/en/latest/installation.html) for your operating system, pipenv is a tool which manages your python virtual environments for you. 2. Run the commands ``pipenv sync --dev`` and ``pipenv shell`` to create and setup the virtual environment.