{"id":26664593,"url":"https://github.com/gatlenculp/grade-forecast","last_synced_at":"2025-03-25T16:37:05.927Z","repository":{"id":282660829,"uuid":"949279933","full_name":"GatlenCulp/grade-forecast","owner":"GatlenCulp","description":"Tool for forecasting and tracking your university grades to adjust your priorities","archived":false,"fork":false,"pushed_at":"2025-03-16T04:57:30.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T05:24:59.637Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/GatlenCulp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"docs/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-16T04:41:18.000Z","updated_at":"2025-03-16T04:57:34.000Z","dependencies_parsed_at":"2025-03-16T05:36:01.579Z","dependency_job_id":null,"html_url":"https://github.com/GatlenCulp/grade-forecast","commit_stats":null,"previous_names":["gatlenculp/grade-forecast"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GatlenCulp%2Fgrade-forecast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GatlenCulp%2Fgrade-forecast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GatlenCulp%2Fgrade-forecast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GatlenCulp%2Fgrade-forecast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GatlenCulp","download_url":"https://codeload.github.com/GatlenCulp/grade-forecast/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245501280,"owners_count":20625745,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2025-03-25T16:37:05.242Z","updated_at":"2025-03-25T16:37:05.919Z","avatar_url":"https://github.com/GatlenCulp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Grade Forecast\n\n![Uses the Cookiecutter Data Science project template, GOTem style](https://img.shields.io/badge/GOTem-Project%20Instance-328F97?logo=cookiecutter)\n\n[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)\n\n\u003c!-- [![tests](https://github.com/GatlenCulp/grade-forecast/actions/workflows/tests.yml/badge.svg)](https://github.com/GatlenCulp/grade-forecast/actions/workflows/tests.yml) --\u003e\n\n\u003c!-- ![GitHub stars](https://img.shields.io/github/stars/GatlenCulp/grade-forecast?style=social) --\u003e\n\n\u003e [!NOTE]\n\u003e This project was created using [Gatlen's Opinionated Template (GOTem)](https://github.com/GatlenCulp/gatlens-opinionated-template), a cutting-edge project template for power users and researchers.\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com//grade-forecast\"\u003e\n    \u003c!-- Please provide path to your logo here --\u003e\n    \u003cimg src=\"https://picsum.photos/id/237/200/300\" alt=\"Logo\" style=\"max-width: 250px;\"/\u003e\n  \u003c/a\u003e\n  \u003cbr/\u003e\n  \u003cb\u003eGrade Forecast\u003c/b\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\n\u003e **[?]**\n\u003e Provide a brief description of your project here. What does it do? Why is it useful?\n\u003e **\\[View the full documentation here\\](https://Gatlen Culp.github.io/grade-forecast) ➡️**\n\n______________________________________________________________________\n\n## 00 Table of Contents\n\n- [Grade Forecast](#grade-forecast)\n  - [00 Table of Contents](#00-table-of-contents)\n  - [01 About](#01-about)\n  - [02 Getting Started](#02-getting-started)\n    - [02.01 Prerequisites](#0201-prerequisites)\n    - [02.02 Installation](#0202-installation)\n  - [03 Usage](#03-usage)\n  - [04 Project Structure](#04-project-structure)\n  - [05 Contributing](#05-contributing)\n  - [06 License](#06-license)\n\n______________________________________________________________________\n\n## 01 About\n\n\u003e **[?]**\n\u003e Provide detailed information about your project here.\n\u003e\n\u003e - What problem does it solve?\n\u003e - What makes it unique?\n\u003e - What are its key features?\n\u003e - Who is it for?\n\n\u003cdetails\u003e\n\u003csummary\u003e📸 Screenshots\u003c/summary\u003e\n\u003cbr\u003e\n\n\u003e **[?]**\n\u003e Please provide your screenshots here.\n\n|                                    Home Page                                    |                                    Login Page                                    |\n| :-----------------------------------------------------------------------------: | :------------------------------------------------------------------------------: |\n| \u003cimg src=\"https://picsum.photos/id/237/200/300\" title=\"Home Page\" width=\"100%\"\u003e | \u003cimg src=\"https://picsum.photos/id/237/200/300\" title=\"Login Page\" width=\"100%\"\u003e |\n\n\u003c/details\u003e\n\n______________________________________________________________________\n\n## 02 Getting Started\n\n### 02.01 Prerequisites\n\n\u003e **[?]**\n\u003e List all dependencies and requirements needed before installing the project:\n\u003e\n\u003e ```bash\n\u003e # Example\n\u003e python \u003e= 3.8\n\u003e pip \u003e= 21.0\n\u003e ```\n\n### 02.02 Installation\n\n\u003e **[?]**\n\u003e Provide step-by-step installation instructions:\n\u003e\n\u003e **01. Clone the repository**\n\u003e\n\u003e ```bash\n\u003e git clone https://github.com/GatlenCulp/grade-forecast.git\n\u003e cd grade-forecast\n\u003e ```\n\u003e\n\u003e **02. Install dependencies**\n\u003e\n\u003e ```bash\n\u003e pip install -e .\n\u003e ```\n\n______________________________________________________________________\n\n## 03 Usage\n\n\u003e **[?]**\n\u003e Provide basic usage examples with code snippets:\n\u003e\n\u003e ```python\n\u003e from gf import example\n\u003e\n\u003e # Initialize\n\u003e example.start()\n\u003e\n\u003e # Run a basic operation\n\u003e result = example.process(\"data\")\n\u003e print(result)\n\u003e ```\n\n______________________________________________________________________\n\n## 04 Project Structure\n\nThis project follows the structure of [Gatlen's Opinionated Template (GOTem)](https://github.com/GatlenCulp/gatlens-opinionated-template):\n\n```\n📁 .\n├── 📁 data               \u003c- Data directories for various stages\n├── 📚 docs               \u003c- Documentation\n├── 📋 logs               \u003c- Log files\n├── 📁 notebooks          \u003c- Jupyter notebooks\n├── 🗑️ out                \u003c- Output files, models, etc.\n└── 🚰 gf  \u003c- Source code\n    ├── ⚙️ config.py      \u003c- Configuration settings\n    ├── 🐍 dataset.py     \u003c- Data processing\n    ├── 🐍 features.py    \u003c- Feature engineering\n    ├── 📁 modeling       \u003c- Model training and prediction\n    └── 🐍 plots.py       \u003c- Visualization code\n```\n\nFor a more detailed explanation of the project structure, see the [CONTRIBUTING.md](docs/CONTRIBUTING.md) file.\n\n______________________________________________________________________\n\n## 05 Contributing\n\nWe welcome contributions to this project! Please see our [contribution guidelines](docs/CONTRIBUTING.md) for detailed information on how to:\n\n- Set up your development environment\n- Submit issues and feature requests\n- Create pull requests\n- Get support\n\n______________________________________________________________________\n\n## 06 License\n\nThis project is licensed under the MIT - see the [LICENSE](LICENSE) file for details.\n\nA tool for forecasting and tracking your university grades to adjust your priorities.\n\n## Installation\n\nClone the repository and install the package:\n\n```bash\ngit clone https://github.com/yourusername/grade-forecast.git\ncd grade-forecast\npip install -e .\n```\n\n## Usage\n\nGrade Forecast provides both an interactive CLI and direct command-line commands.\n\n### Interactive Mode\n\nTo start the interactive CLI:\n\n```bash\ngrade-forecast run\n```\n\n### Command-Line Commands\n\n#### List all courses\n\n```bash\ngrade-forecast list\n```\n\nThis will display all available courses with their aliases.\n\n#### Show a summary of all courses\n\n```bash\ngrade-forecast summary\n```\n\n#### Display information for a specific course\n\nYou can use the course name, alias, or index:\n\n```bash\ngrade-forecast course \u003ccourse_name\u003e\ngrade-forecast course \u003calias\u003e\ngrade-forecast course \u003cindex\u003e\n```\n\nWith detailed information:\n\n```bash\ngrade-forecast course \u003ccourse_name\u003e --details\n```\n\nIf you run the command without specifying a course, it will display all available courses with their aliases:\n\n```bash\ngrade-forecast course\n```\n\n#### List all tasks in a course\n\n```bash\ngrade-forecast tasks \u003ccourse_name\u003e\ngrade-forecast tasks \u003calias\u003e\n```\n\nIf you run the command without specifying a course, it will display all available courses with their aliases:\n\n```bash\ngrade-forecast tasks\n```\n\n#### Analyze a specific task\n\n```bash\ngrade-forecast task \u003ccourse_name\u003e \u003ctask_name\u003e\ngrade-forecast task \u003calias\u003e \u003ctask_index\u003e\n```\n\nIf you run the command without specifying a task, it will display all available tasks in the course:\n\n```bash\ngrade-forecast task \u003ccourse_name\u003e\n```\n\n#### Update a task's grade\n\n```bash\ngrade-forecast update \u003ccourse_name\u003e \u003ctask_name\u003e \u003cgrade\u003e\ngrade-forecast update \u003calias\u003e \u003ctask_index\u003e \u003cgrade\u003e\n```\n\nIf you run the command without specifying a grade, it will prompt you to enter one:\n\n```bash\ngrade-forecast update \u003ccourse_name\u003e \u003ctask_name\u003e\n```\n\nExample:\n\n```bash\ngrade-forecast update compsys \"Homework #1\" 95\ngrade-forecast update cs 1 95  # Using alias and task index\n```\n\n#### Compare multiple courses\n\n```bash\ngrade-forecast compare \u003ccourse1\u003e \u003ccourse2\u003e ...\ngrade-forecast compare \u003calias1\u003e \u003calias2\u003e ...\n```\n\nIf you run the command without specifying any courses, it will display all available courses with their aliases:\n\n```bash\ngrade-forecast compare\n```\n\nExample:\n\n```bash\ngrade-forecast compare compsys linalg\ngrade-forecast compare cs la  # Using aliases\n```\n\n## Features\n\n- Track and forecast your grades across multiple courses\n- Analyze the impact of individual assignments on your final grade\n- Visualize grade trends and projections\n- Prioritize tasks based on their impact on your final grade\n- Compare performance across different courses\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgatlenculp%2Fgrade-forecast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgatlenculp%2Fgrade-forecast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgatlenculp%2Fgrade-forecast/lists"}