Metadata-Version: 2.1
Name: mosspy
Version: 1.0.8
Summary: A Python client for Moss: A System for Detecting Software Similarity
Home-page: https://github.com/soachishti/moss.py
Author: soachishti
Author-email: soachishti@outlook.com
License: UNKNOWN
Download-URL: https://github.com/soachishti/moss.py/releases
Keywords: moss,similarity,detecting,plagiarism
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: beautifulsoup4
Requires-Dist: lxml

# moss.py

A Python client for [Moss](http://theory.stanford.edu/~aiken/moss/): A System for Detecting Software Similarity

## Introduction

It is a Python interface for [Moss](http://theory.stanford.edu/~aiken/moss/) client. It was written for [AutoGrader](https://github.com/BilalZaib/AutoGrader) for handling similarity in Python assignment submission. 

It was written using the [original bash script/documentation](http://moss.stanford.edu/general/scripts.html) and its [PHP](https://github.com/Phhere/MOSS-PHP) dialect.

### Installation

```shell
pip install mosspy
```

### Usage

```python
import mosspy

userid = 987654321

m = mosspy.Moss(userid, "python")

m.addBaseFile("submission/a01.py")
m.addBaseFile("submission/test_student.py")

# Submission Files
m.addFile("submission/a01-sample.py")
m.addFilesByWildcard("submission/a01-*.py")

url = m.send() # Submission Report URL

print ("Report Url: " + url)

# Save report file
m.saveWebPage(url, "submission/report.html")

# Download whole report locally including code diff links
mosspy.download_report(url, "submission/report/", connections=8)
```

## Python Compatibility

* [Python](http://www.python.com) - v2.7.* and v3.*

## Similar Project

* [ocaml-moss](https://github.com/Chris00/ocaml-moss) OCaml client 
* [cl-moss](https://github.com/wsgac/cl-moss) Common Lisp
* [moji](https://github.com/nordicway/moji) Java version
* [MOSS-PHP](https://github.com/Phhere/MOSS-PHP) PHP version
* [GUI for Windows](https://onedrive.live.com/?cid=b418048abfa842a7&id=B418048ABFA842A7%2136714&ithint=folder,.txt&authkey=!ACqFMI0kmA4L1mc) GUI for Windows

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/soachishti/moss.py/blob/master/LICENSE) file for details


