Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antrikshmisri/checkpoint
Create restore points for your project locally
https://github.com/antrikshmisri/checkpoint
checkpoint cli python restore-points ui
Last synced: 2 months ago
JSON representation
Create restore points for your project locally
- Host: GitHub
- URL: https://github.com/antrikshmisri/checkpoint
- Owner: antrikshmisri
- License: mit
- Created: 2021-06-13T18:40:41.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-08-22T09:16:55.000Z (over 2 years ago)
- Last Synced: 2024-10-13T07:44:16.728Z (3 months ago)
- Topics: checkpoint, cli, python, restore-points, ui
- Language: Python
- Homepage: https://antrikshmisri.github.io/checkpoint/
- Size: 2.45 MB
- Stars: 19
- Watchers: 1
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Checkpoint
[](http://checkpoint.antriksh.live/)
[](https://github.com/antrikshmisri/checkpoint)
[](https://www.python.org/) [](https://forthebadge.com)
[](https://www.codacy.com/gh/antrikshmisri/checkpoint/dashboard?utm_source=github.com&utm_medium=referral&utm_content=antrikshmisri/checkpoint&utm_campaign=Badge_Grade)  [](https://codeclimate.com/github/antrikshmisri/checkpoint/maintainability)
[](https://checkpoint-installer-bucket.s3.amazonaws.com/installers/windows+Installer/windows-install-checkpoint.exe) [](https://checkpoint-installer-bucket.s3.amazonaws.com/installers/macos+Installer/macos-install-checkpoint) [](https://checkpoint-installer-bucket.s3.amazonaws.com/installers/ubuntu+Installer/ubuntu-install-checkpoint)
[](https://GitHub.com/Naereen/StrapDown.js/releases/) [](https://pepy.tech/project/pycheckpoint) [](http://makeapullrequest.com)
Checkpoint is a tool that helps you to create restore points for your project
Unlike other tools like git, checkpoint makes the whole process as simple as a few click
Plus, there is no need for a remote repository, checkpoint does everything locally
## How does it work?
Checkpoint provides multiple `Sequence` classes that have member functions which execute based on their order in the sequence. These sequences are used to perform all the sequential operations that are required to create a restore point. Some of these sequences are:
* `IOSequence`: This sequence is used to perform all the input/output sequential operations.
* `CLISequence`: This sequence is used to perform all the CLI operations which includes parsing the arguments, determining the action and performing the action.
Checkpoint also supports custom sequences that can be used to initialize checkpoint in different environments. For example, if a checkpoint is to be initialized in a UI environment a sequence for UI can be created and passed to the `Checkpoint` constructor.
**Detailed documentation can be found [here](http://checkpoint.antriksh.live/)**
## How to use checkpoint?
To run checkpoint in UI environment, run the following command:
##### Run checkpoint in UI environment
```bash
checkpoint --run-ui
```
The following is an example of how to use checkpoint in a CLI environment.
##### Initialize checkpoint in the target project
```bash
checkpoint --action=init --path=path/to/project
```
*After initialization a `.checkpoint` directory is created in the target project. If the project is git initialized, this directory should be added to the git ignore file.*
##### Creating a restore point
```bash
checkpoint --name=restore_point_name --action=create --path=path/to/project
```
##### Jumping to a restore point
```bash
checkpoint --name=restore_point_name --action=restore --path=path/to/project
```
##### Deleting a restore point
```bash
checkpoint --name=restore_point_name --action=delete --path=path/to/project
```
##### Version of checkpoint
```bash
checkpoint --name=restore_point_name --action=version --path=path/to/project
```
## Installation
`pip install pycheckpoint`
### Development
##### 1. Get the source code by cloning from the remote repository.
```bash
git clone https://github.com/antrikshmisri/checkpoint.git
```
##### 2. Create and activate a virtual environment.
```bash
python -m venv venv
source venv/bin/activate
```
##### 3. Get the dependencies
```bash
pip install -r requirements/default.txt
```
##### 4. Install checkpoint as a local project.
```bash
pip install .
```
##### 5. Run the tests
```bash
pip install -r requirements/test.txt
pytest -v checkpoint/tests/
```
## Code of Conduct
Please go through the code of conduct before contributing to this project which can be found [here](./CODE_OF_CONDUCT.md).
## Screenshots
