Metadata-Version: 2.1
Name: check11
Version: 0.0.1
Summary: Client side of Check11 service for cpnits.com
Author-email: "Victor G.B. Peters" <victor@jeex.eu>
Project-URL: Homepage, https://github.com/jeex/check11
Project-URL: Issues, https://github.com/jeex/check11/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYAML
Requires-Dist: requests
Requires-Dist: colorama
Requires-Dist: importlib
Requires-Dist: pytest

# Cpnits Check11

Check11 checks Python >= 3.10 code for cpnits.com students. 
## You need a github account
Check11 relies on a working github in your computer. 

Your github alias needs to be added to [cpnits.com/check11](https://cpnits.com/check11). Ask your teacher to do that for you.

You can only check11 assignments that come with a check11 command. Your assignment should have a line somewhere mentioning: *"Use* 
```
check11 assignmentname
``` 
*to check your solution for proper structure and output."*

## How to install check11
1. Make sure you have an activated **virtual environment**.
2. Pip install check11 with...
```
pip install check11
```

## How to use check11: 
Let's asume that your assignment is called **nerdy**.

Check11 needs a path to the directory containing the Python files that you want tested.

With an **absolute path** (starting with **/**) to the dir containg the python files:
```
check11 nerdy /absolute/path/to/dir/with/assignment
```

or with a **relative path** (a relative path never starts with **/**): 
```
check11 nerdy relative/path
```

or by omitting the path and run check11 from the **current working directory**: 
```
check11 nerdy
```

## For **help**: 
```
check11 -h 
```

or:
```
check11 -help
```

## Additional arguments
Additional argument for **no traceback** in the testreport:  
```
check11 nerdy --t /some/dir 
```

Additional argument for **errors only** in the test report:  
```
check11 nerdy --e /some/dir 
```

Additional argument for **clearing the prompt** before printing the test report:  :
```
check11 nerdy --p /some/dir 
```

Combined arguments for **no traceback** and **errors only**: 
```
check11 nerdy --et /some/dir 
```

## Examples
Example, where **nerdy** is the name of the assignment (assignment in **current dir**, **errors only**, **no traceback**, **clear prompt**): 
```
check11 nerdy --etp
```

Example (assignment in **relative dir**, **clear prompt**): 
```
check11 nerdy --p some/dir
```

<!-- [GitHub-flavored Markdown](https://guides.github.com/features/mastering-markdown/) -->
