Metadata-Version: 2.5
Name: camp-comm
Version: 0.1.3
Summary: Camp-comm CLI tool
Author-email: Aditya Kumar <adityakumar0@zohomail.in>
License: MIT
License-File: LICENSE
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# camp-comm

camp-comm (short for "Campus Commit") is a plug-and-play online version control system with a simple and lightweight terminal based user-interface.

## Installation
`pip install camp-comm`

or 

`pipx install camp-comm`

## Launching

Open the terminal and run `camp-comm` in your project folder.

## Workflow

The workflow is simple, someone creates a project, and sets 3 passwords - read, commit, delete; each having specific power

- **read** - anyone having this can check logs and checkout (download) any version of a project. but they cant make any commit.
- **commit** - anyone having this has all power of read password + ability to commit.
- **delete** - read + commit + power to update(rotate) other paaswords and also delete the entire project. Therefore it is recommended the creator does not share this to anyone

This 3 passwords system removes the need to creating user data and hence avoids hectic setups and configurations. Essentially making it plug-and-play.

Just create a project and share password to people according to their roles.

## ignores.json

ignores.json - this file in .vcs folder can be used to specify folders/extensions/exact file to be ignored while commiting.

- **IGNORE_DIRS**: folder names
- **IGNORE_EXT** : extension / file type to be ignored
- **IGNORE_FILES** : exact file names to be ignored
