Metadata-Version: 2.1
Name: temmies-cli
Version: 1.0.1
Summary: A command-line tool for managing assignments using the Temmies library
Home-page: https://github.com/Code-For-Groningen/temmies-cli
Author: Boyan K.
Author-email: boyan@confest.im
License: GPLv3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=7.0
Requires-Dist: requests
Requires-Dist: lxml
Requires-Dist: beautifulsoup4
Requires-Dist: keyring
Requires-Dist: temmies
Requires-Dist: tqdm

# temmies-cli
Command Line tool using the [temmies library](https://github.com/Code-For-Groningen/temmies)

## Installation
> [!NOTE]
> I am currently working on an arch linux package for this tool (AUR). Open an issue if I forget and/or you want me to package it for another distro. A bash script is also in the works.

```bash
pipx install temmies-cli
```

## Usage

### Initialize a new assignment
```bash
temmies init {year}/{course}/{assignment} {path}
```
> `temmies init 2024-2025/advalgo/labs-wk2 .`

### Optional args
- `-s` : Search for an assignment instead of providing the link i.e. `temmies init -s "Advanced Algorithms" `.

### File hierarchy example
Once the command is run.
```
 .
├── practical_1
│   │   .temmies <-- This file holds all relevant information
│   ├── pizza
│   │   ├── tcs
│   │   │   ├── 1.in
│   │   │   ├── 1.out
│   │   │   ├── 6.in
│   │   │   ├── 6.out
│   └── tunnel
│   │   ├── tcs
│   │   │   ├── 1.in
│   │   │   ├── 1.out
│   │   │   ├── 2.in
│   │   │   ├── 2.out
│   │   │   ├── 3.in
│   │   │   ├── 3.out
```

## `temmies submit {file}`
> `temmies submit main.c`
Submits a file to the relevant assignment. You can pass multiple files as well.

### Optional args
- `-q` : Quiet submission, don't wait for output

## `temmies status`

Shows an overview of the current assignment's status.

### Optional args
- `-d` : Adds some more detail

