Cal Poly Knowledge Graph
A GraphQL API for exploring information about Cal Poly.
Getting Started
Clone the repository
git clone https://github.com/calpoly-csai/cal-poly-knowledge-graph.gitSet up the development environment. Run these commands at the root of the cal-poly-knowledge-graph folder.
conda env create --file environment.yml
conda activate cp-knowledge-graph
pre-commit installLaunch the development server
python app.pyVisit http://127.0.0.1:5000/graphql in your browser to interact with the API. For more information about how to query data using GraphQL, check out the docs. Visit the web scrapers section to get started with development.
Web Scrapers
The knowledge graph stays up to date by periodically running web scrapers that grab updated information from external sources. If you want to build your own scraper, the CollegeScraper works as a good example template to get started. All of the scrapers live in the scrapers folder. When you run python app.py, all scrapers will be loaded and run to populate the database before the API server starts. If you want to run specific scrapers only, you can pass a list of scrapers to the program. For example, python app.py -s CollegeScraper MusicDepartmentScraper will only run the college scraper and the music department scraper.
Visualizing the Knowledge Graph
With the development server running, you can explore a visualization of the Cal Poly Knowledge Graph at http://127.0.0.1:5000/visualize.
Tests
Tests are found in the /tests folder. To run tests, use the python -m pytest command in your terminal.
Resources
