Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#208 Updating readme to add badge #209

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
+9 −5
Open

#208 Updating readme to add badge #209

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e307035
#208 Updating readme to add badge
Conor0Callaghan Dec 3, 2024
807d4b2
Merge branch 'pittcsc:dev' into dev
Conor0Callaghan Dec 9, 2024
de6bca8
Update README.md
Conor0Callaghan Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +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)](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
Expand Down Expand Up @@ -58,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.
Expand Down