Skip to content

Commit cbe748b

Browse files
authored
Merge pull request #209 from Conor0Callaghan/dev
#208 Updating readme to add badge
2 parents a581eec + 9220c8e commit cbe748b

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,18 @@
33
![Build Status](https://img.shields.io/github/actions/workflow/status/pittcsc/PittAPI/autotest.yml?branch=dev)
44
![License](https://img.shields.io/badge/license-GPLv2-blue.svg)
55
![Python Version](https://img.shields.io/badge/python-%3E%3D%203.10-green.svg)
6+
[![Pypi Version](https://img.shields.io/pypi/v/pittapi.svg)](https://pypi.org/project/PittAPI/)
67

78
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.
89

10+
## Installation
11+
12+
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.
13+
14+
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.
15+
2. Run the commands ``pipenv sync --dev`` and ``pipenv shell`` to create and setup the virtual environment.
16+
3. Install the PittAPI in the new virtual environment ``pip install PittAPI``, see the usage guide below for further information.
17+
918
## Usage examples
1019

1120
```python
@@ -58,11 +67,6 @@ medium_dict = dining.get_locations()
5867
hours = dining.get_location_hours("The Eatery", datetime.datetime(2024, 4, 12))
5968
```
6069

61-
## Local Setup
62-
Install Python 3.13 and ``pipenv``.
63-
64-
Run ``pipenv install`` and ``pipenv shell`` to create and setup the virtual environment.
65-
6670
## Contributing
6771

6872
Read our [contributing guidelines](/CONTRIBUTING.md) to learn how to contribute to the Pitt API.

0 commit comments

Comments
 (0)