Official Commit man python package
Project description
Commit Man
Commit-Man is a version control system that helps the user keep track of and manage different versions of their files. It features a CLI and a GUI - the complete set of features are available in the CLI, while the GUI features a limited set of features currently (primarily repository browsing functions and viewing diffs across versions).
A repository can have a .gitignore file that specifies for which files changes are to be ignored across versions (when creating new versions). A special folder (.cm) in each repository stores data for version management.
CLI features
- Initializing a repository
- Committing a version and making a new version
- Reverting back to an old version
- Reinitializing in case of corrupted data
- Displaying Logs and Command description
GUI features
- Viewing commit history
- Browsing the repository
- Viewing diffs of files across versions
- Viewing repository info
Installing
A step by step series of examples that tell you how to get a development env running
Install from PyPi:
pip install commit-man
Install from Source
git clone https://github.com/atharva-Gundawar/commit-man
cd commit-man
python setup.py install
The Commands
Initializing a Repository
Initialize Commit man in the current directory
cm init
Committing a version
Commits curent version of working directory
cm commit <message>
Reverting back to an old version
Reverts to an old version of working directory
cm revert <Commit_Number> [-f | --force]
Reinitialize Commit Man
Reinitialize Commit man in the current directory
cm reinit
Displaying Logs
Displays Log file in a tabular format on the Terminal
cm showlog
Displaying Command descriptions
Displays Command descriptions on the Terminal
cm man
Built With
- Python - An interpreted high-level general-purpose programming language.
- Gitignore Parser - A spec-compliant gitignore parser for Python 3.5+
- Docopt - Command-line interface description language
Contributing
Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests.
Authors
- Atharva Gundawar - Initial work - Github handle
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file Commit-Man-0.0.3.tar.gz
.
File metadata
- Download URL: Commit-Man-0.0.3.tar.gz
- Upload date:
- Size: 8.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 368732d7f424640dc34fe28b36d4fed62b3ebb4c1f489dc57ee112638cf6d779 |
|
MD5 | 454d5d9989b6dada7de45e25e0dd76ab |
|
BLAKE2b-256 | f1e705cb7b50eca268b074656a0da4dc5505a42893e17a0822c25988a5ed96db |
File details
Details for the file Commit_Man-0.0.3-py3-none-any.whl
.
File metadata
- Download URL: Commit_Man-0.0.3-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68bb53f016ccd556eee7e4517342fe6d5125e26b9741d2752365a034d21be62e |
|
MD5 | edf6709c2ee722698d6ca9914707ee70 |
|
BLAKE2b-256 | 6351d466682eaf88f1b474fc3801d97ea2c1ff8319234bed154f23f0e050c7f8 |