{"id":43300267,"url":"https://github.com/compsci-adl/courses-api","last_synced_at":"2026-02-01T19:37:44.067Z","repository":{"id":249606734,"uuid":"823521842","full_name":"compsci-adl/courses-api","owner":"compsci-adl","description":"API for getting Adelaide University course information","archived":false,"fork":false,"pushed_at":"2026-01-10T03:12:31.000Z","size":20567,"stargazers_count":26,"open_issues_count":2,"forks_count":14,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-11T00:53:01.403Z","etag":null,"topics":["api","fastapi","python","scraper","university"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/compsci-adl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-07-03T07:39:24.000Z","updated_at":"2026-01-10T03:12:35.000Z","dependencies_parsed_at":"2025-08-28T05:17:27.101Z","dependency_job_id":"4164d75f-5ac3-458f-9774-73c46bc7bef2","html_url":"https://github.com/compsci-adl/courses-api","commit_stats":null,"previous_names":["compsci-adl/courses-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/compsci-adl/courses-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compsci-adl%2Fcourses-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compsci-adl%2Fcourses-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compsci-adl%2Fcourses-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compsci-adl%2Fcourses-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/compsci-adl","download_url":"https://codeload.github.com/compsci-adl/courses-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compsci-adl%2Fcourses-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28987283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T18:17:03.387Z","status":"ssl_error","status_checked_at":"2026-02-01T18:16:57.287Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","fastapi","python","scraper","university"],"created_at":"2026-02-01T19:37:44.002Z","updated_at":"2026-02-01T19:37:44.061Z","avatar_url":"https://github.com/compsci-adl.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Courses API\nCourses API is a tool to scrape course information from the Adelaide University website and provide course data to other CS Club Open Source Team projects via an API endpoint.\n\n## Getting Started\n\nTo get started, please follow these steps:\n\n1. Install `uv` if not already installed:\n\n    Linux, macOS, Windows (WSL)\n    ```bash\n    curl -LsSf https://astral.sh/uv/install.sh | sh\n    ```\n    Windows (Powershell)\n    ```powershell\n    powershell -ExecutionPolicy ByPass -c \"irm https://astral.sh/uv/install.ps1 | iex\"\n    ```\n\n2. Install dependencies:\n\n    ```sh\n    uv sync\n    pre-commit install\n    ```\n\n3. Make a `.env` file and copy `.env.example` into it\n\n### Running the API Server\n\n1. Start the FastAPI server:\n\n    ```sh\n    uv run fastapi dev src/server.py\n    ```\n\n2. Open [http://localhost:8000/docs](http://localhost:8000/docs) with your browser to see the API documentation and to test the available endpoints.\n\n### Running the scraper\n\nStart the scraper (Note: Scraping all the courses may take over an hour):\n\n```sh\nuv run python3 src/scraper.py\n```\n\n#### Debugging\nThe output level of the logger can be configured in the `.env`. Set `DEFAULT_LOGGING_LEVEL` to your desires level such as `DEBUG` and `ERROR`. `DEBUG` outputs all logs into a file, including errors. `ERROR` only logs errors into a log file.\n\n## Contributing\n\nWe welcome contributions to enhance Courses API! If you find any issues, have suggestions, or want to request a feature, please follow our [Contributing Guidelines](https://github.com/compsci-adl/.github/blob/main/CONTRIBUTING.md).\n\n## License\n\nThis project is licensed under the MIT License.\nSee [LICENSE](LICENSE) for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompsci-adl%2Fcourses-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompsci-adl%2Fcourses-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompsci-adl%2Fcourses-api/lists"}