https://github.com/datacamp/shellwhat

https://github.com/datacamp/shellwhat

fs le

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/datacamp/shellwhat
• Owner: datacamp
• License: agpl-3.0
• Created: 2017-07-27T18:06:48.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-06-21T14:51:54.000Z (almost 4 years ago)
• Last Synced: 2024-10-13T21:54:18.016Z (over 1 year ago)
• Topics: fs, le
• Language: Python
• Homepage: https://shellwhat.readthedocs.io
• Size: 120 KB
• Stars: 2
• Watchers: 25
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
> :warning: **This repo has outdated tokens in its travisci config**

> To make new releases for this project it needs to be moved to circleci

shellwhat

=========

[![Build Status](https://travis-ci.org/datacamp/shellwhat.svg?branch=master)](https://travis-ci.org/datacamp/shellwhat)

[![codecov](https://codecov.io/gh/datacamp/shellwhat/branch/master/graph/badge.svg)](https://codecov.io/gh/datacamp/shellwhat)

[![PyPI version](https://badge.fury.io/py/shellwhat.svg)](https://badge.fury.io/py/shellwhat)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdatacamp%2Fshellwhat.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdatacamp%2Fshellwhat?ref=badge_shield)

`shellwhat` enables you to write Submission Correctness Tests (SCTs) for interactive Shell exercises on DataCamp.

- If you are new to teaching on DataCamp, check out https://instructor-support.datacamp.com.

- If you want to learn what SCTs are and how they work, visit [this article](https://instructor-support.datacamp.com/courses/course-development/submission-correctness-tests) specifically.

- For a complete overview of all functionality inside `shellwhat` and articles about what to use when, consult https://shellwhat.readthedocs.io.

Installing

----------

```bash

pip install shellwhat

```

Development

-----------

Install everything needed for developing:

```bash

pip install -r requirements.txt

pip install -e .

```

By default, the `DummyParser` is used, that does not parse the shell code.

Hence, you can not run tests that need this parser:

```bash

pytest -m "not osh"

```

If you also want to run these 'parser tests',

there is a Dockerfile to parse shell commands with

the [Oil parser](https://github.com/oilshell/oil):

```bash

# Look in Makefile for details

SHELLWHAT_PARSER='docker' make test

```

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdatacamp%2Fshellwhat.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdatacamp%2Fshellwhat?ref=badge_large)