Toronto Bids Project

The Toronto Bids Project is an initiative aimed at promoting transparency and accountability in the procurement process of the Toronto City Council. The project involves scraping request for proposal (RFP) documents from the Toronto City Council's procurement tool, SAP Ariba, and making the information publicly accessible through a database. The goal is to make the procurement process more accessible to the public even after the due date of the RFPs has passed.

Table of Contents

1. Project Outline
2. Getting Started
3. How to Contribute

1. Project Outline

The project consists of the following main stages:
a. Scraping
b. Ingestion
c. Making the data public

a. Scraping

The first stage of the project involves scraping RFP information from the Toronto City Council's procurement tool, SAP Ariba. A custom-built scraping tool has been developed to crawl the SAP Ariba website and extract relevant information about each RFP, including structured metadata and PDF documents containing detailed information.

In addition, the city posts some metadata about the RFPs through the Open Data Portal, and a separate scraper has been developed to capture this information.

Get more familiar with the Data Sources and udnerstand how the Scraper is working

b. Ingestion

The next stage of the project involves ingestion of the extracted information into a database. The downloaded data consists of structured metadata as well as PDF documents containing additional information. A separate script is used to extract human-readable text from the PDF documents, which is then added to the main table of data.

The extracted information is then stored in an SQL database for easier management and accessibility.

Find info on how the ingestion and database processes are being managed

c. Making the data public

The final stage of the project involves making the information publicly accessible through a user-friendly website. The goal is to provide an easy-to-use platform for accessing the information contained in the RFPs, even after the due date has passed, promoting transparency and accountability in the procurement process of the Toronto City Council.

This stage also requires making an API to allow programmatic access to the database of RFP information. This API will allow developers to programmatically access and retrieve data from the database for use in their own applications and tools. The API should include endpoints for retrieving information about specific RFPs, searching for RFPs based on certain criteria, and retrieving metadata about the RFPs. The API will be a critical component of the project, allowing the data to be used in a wide range of applications and promoting the goal of transparency and accessibility in the Toronto City Council's procurement process.

Find more information on the Front End and ongoing projects here

2. Getting Started

OSX

Pre-requisites

Clone the package to the chosen folder (example using git CLI and HTTPS below):

git clone https://github.com/CivicTechTO/toronto-bids.git
cd toronto-bids

libmagic is a pre-requisite needed for the python module python-magic. Install via Homebrew/macports

• brew install libmagic
• port install file

The README.md of the python-magic module has a section dedicated to troubleshooting libmagic errors

Python

Use python3.8 or higher, currently the project is setup to use python3.9

We're utilize GNU make to help setup and run the python scrapers and other scripts. Currently the Makefile is tested and supported on Mac OSX (need contributors for Windows).

To setup and run the Jupyter notebook just at the top level of this repo you can run:

make run-jupyter-notebook

This sets up the python virtual environment and requirements and runs the Jupyter server on the scrapers directory. For further inspect or extending the make build tool, the targets are defined in Makefile Currently it is just extended for the Jupyter notebooks that are written, eventually it should be expanded to support all the build/setup tasks needed for the other projects.

To clean the project:

make clean

Below are the instructions if you don't want to follow make for the python projects:

It's recommended to use a virtual environment to manage python dependencies. The commands below assume that the toronto-bids folder is the pwd in your terminal:

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

This will setup a virtual environment within the toronto-bids folder, activate it, and install the project modules into the virtual environment. Keep the virtual environment active while working on the project. To deactivate the virtual environment (once switching to another project for instance), simply run:

deactivate

To enable the virtual environment again, run source venv/bin/activate

Clojure

The backend server currently is written in Clojure and resides at app/server/toronto-bids/toronto-bids.

You can follow the README for prequisites and running the application.

Two major requirements are clojure and lein build tool.

Running the backend server from the top level repo:

make run-server

To build the jars:

make build-uberjar

3. How to Contribute

Thank you for your interest in contributing to Open Toronto Bids! There are multiple ways to contribute, and we appreciate all contributions. In case you have questions, feel free to join our slack group here (civictechto.slack.com/#proj-torontobids)

1. Bug Reports
2. Bug Fixes
3. Reporting a Security Issue
4. Bigger Pieces of work and upcoming projects