pwsa-jobs-api

An API for scraping and serving job listings from the Pittsburgh Water & Sewer Authority website.

Getting Started

Disclaimer This project is currently a non-production version!

Clone the repository:

git clone https://github.com/jtroussard/pwsa-jobs-api.git
cd pwsa-jobs-api

Set up environment and install dependencies:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Currently this is a non-production application. Eventually it will be design to be setup as a plug in service for a larger application.

Requires project dependencies be installed

pytest tests/

Please feel free to fork, contribute, redesign, build off from.

Fork the Repository:
- Navigate to the repository on GitHub and click the "Fork" button to create a copy of the repository under your GitHub account.
Clone the Repository:
- Clone the forked repository to your local machine using the command:
```
git clone https://github.com/your-username/pwsa-jobs-api.git
cd pwsa-jobs-api
```
Create a Branch:
- Create a new branch for your feature or bug fix:
```
git checkout -b feature/your-feature-name
```
Make Changes:
- Make your changes to the codebase. Ensure that your code follows the existing coding style and conventions.
Commit Changes:
- Commit your changes with a descriptive commit message:
```
git add .
git commit -m "Add feature: your feature description"
```
Push Changes:
- Push your changes to your forked repository:
```
git push origin feature/your-feature-name
```
Create a Pull Request:
- Navigate to the original repository on GitHub and click the "New Pull Request" button.
- Select the branch you just pushed from your forked repository and submit the pull request.
- Provide a detailed description of your changes in the pull request.

Be Respectful: Treat everyone with respect. Harassment, discrimination, and offensive language will not be tolerated.
Provide Constructive Feedback: Offer constructive feedback and be open to receiving it.
Follow the Coding Standards: Adhere to the coding standards and best practices defined in the repository.

Check Existing Issues: Before creating a new issue, check if the issue already exists.
Create a New Issue: If the issue does not exist, create a new issue with a clear title and detailed description.
Provide Context: Provide as much context as possible, including steps to reproduce the issue, expected behavior, and any relevant screenshots or logs.