Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rootcircle/codemark-cli

CLI app for Codemark for HOF v4.0
https://github.com/rootcircle/codemark-cli

cli click firebase hacktoberfest2023 python

Last synced: 9 days ago
JSON representation

CLI app for Codemark for HOF v4.0

Host: GitHub
URL: https://github.com/rootcircle/codemark-cli
Owner: rootCircle
License: apache-2.0
Created: 2023-04-22T07:19:55.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-10-14T14:03:32.000Z (over 1 year ago)
Last Synced: 2024-04-21T06:33:13.968Z (10 months ago)
Topics: cli, click, firebase, hacktoberfest2023, python
Language: Python
Homepage: https://devfolio.co/projects/codemark-251c
Size: 393 KB
Stars: 6
Watchers: 1
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS.md

Awesome Lists containing this project

README

# CodeMark CLI 🖥️📝🔍

CodeMark CLI is a command-line interface that helps you manage your coding assignments and tests. With this tool, you can easily initialize the configuration, list assignments, fetch and check your code, submit your code for grading, and get AI-powered error recommendations. The tool is designed to simplify your experience with CodeMark and streamline your coding workflow. ⌨️💻👨‍💻

### Website
Visit [here](https://github.com/umeshSinghVerma/codemarkweb/tree/main/codemarkfrontend).

### Download
[](https://github.com/rootCircle/codemark-cli/releases)

## Features

The repository offers the following capabilities:

- **Code Review:** The tool allows developers to generate code reviews and receive feedback to improve code quality. It allows you to match output based on fuzzy, exact, or regex patterns.

- **Plagiarism Detection:** The tool helps detect instances of code plagiarism in submitted assignments, preventing academic dishonesty.

- **Code Submission:** The tool enables students to submit their programming assignments through a streamlined interface.

- **Alias Support:** The tool includes alias support for terminal commands, making it easier to use.

- **Multi-color Output:** The tool provides multi-color output for a more user-friendly experience.

- **Firebase Wrapper Class Library:** The tool includes a Firebase wrapper class library for integration with Firebase database.

- **IPFS Integration:** The tool integrates with IPFS, a distributed file system, to store and share code assignments.

- **Enhanced Error Handling:** The tool has improved error handling in no network situations and other scenarios.

- **Code Review:** Let AI review your code and recommend errors you might be making with the review command.

- **Assignment Management:** Fetch assignments from the cloud using the get command, and list all assignments with the list command.

- **Submission Management:** Submit the code against selected test cases and report errors using the submit command. Also, fetch the result from IPFS storage based on submission ID using the result command.

- **Global Configuration:** Initialize the configuration globally for Codemark using the init command.

- **User Authentication:** Login/logout the user using the init and logout commands.

- **Error Fixing:** Fix any known common issues for the app with the doctor command.

## Usage

To use CodeMark CLI, run the following command:

`codemark|cmk [OPTIONS] COMMAND [ARGS]...`

### Options

- `--help`: Show this message and exit.

### Commands

- `check`: Checks the code against selected test cases and report errors. 🔍🐞
- `doctor`: Fixes any known common issues for the app. 💊🩺
- `get`: Fetches assignments from cloud, based on assignment Code. 🌩️📥
- `init`: Initialize the configuration globally for CodeMark. 🚀🔧
- `list`: Lists all assignments. 📜👀
- `logout`: Logout the user. 🔒👋
- `review`: Let AI review your code and recommend error you might be doing. 🔍💡
- `submit`: Submit the code against selected test cases and report errors. 🚀📝
- `result`: Fetches result from IPFS storage, based on submission ID. 📊📈

### Requirements

CodeMark CLI requires a working internet connection to interact with the cloud database. Additionally, make sure you have Python installed on your system.

## License

CodeMark CLI is released under the Apache-2.0 License. See [LICENSE](LICENSE) for details.

## Support

If you have any questions or issues with CodeMark CLI, please raise an issue request. We are here to help! 💬👋

## Walkthrough Videos
[![CodeMark CLI](https://img.youtube.com/vi/tDkEvjWW7QA/0.jpg)](https://www.youtube.com/watch?v=tDkEvjWW7QA "CodeMark CLI")
[![CodeMark Web](https://img.youtube.com/vi/OzlFier3gPE/0.jpg)](https://www.youtube.com/watch?v=OzlFier3gPE "CodeMark CLI")

## Screenshots
![codemark_submit](https://raw.githubusercontent.com/rootCircle/codemark-cli/main/Screenshots/1.png)
![codemark_review](https://raw.githubusercontent.com/rootCircle/codemark-cli/main/Screenshots/2.png)
![cmk_doctor](https://raw.githubusercontent.com/rootCircle/codemark-cli/main/Screenshots/3.png)

## Logo
![CodeMark logo](https://raw.githubusercontent.com/rootCircle/codemark-cli/main/logo.png)