simple-vcs 1.0.0__tar.gz → 1.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,35 +1,44 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: simple-vcs
3
- Version: 1.0.0
4
- Summary: A simple version control system written in Python
5
- Home-page: https://github.com/yourusername/simple-vcs
6
- Author: Your Name
7
- Author-email: your.email@example.com
8
- Classifier: Development Status :: 4 - Beta
9
- Classifier: Intended Audience :: Developers
10
- Classifier: License :: OSI Approved :: MIT License
11
- Classifier: Operating System :: OS Independent
12
- Classifier: Programming Language :: Python :: 3
13
- Classifier: Programming Language :: Python :: 3.7
14
- Classifier: Programming Language :: Python :: 3.8
15
- Classifier: Programming Language :: Python :: 3.9
16
- Classifier: Programming Language :: Python :: 3.10
3
+ Version: 1.1.0
4
+ Summary: A simple version control system with unique features for easy version management
5
+ Home-page: https://github.com/muhammadsufiyanbaig/simple_vcs
6
+ Author: Muhammad Sufiyan Baig
7
+ Author-email: Muhammad Sufiyan Baig <send.sufiyan@gmail.com>
8
+ License: MIT License
9
+
10
+ Copyright (c) 2024 SimpleVCS
11
+
12
+ Permission is hereby granted, free of charge, to any person obtaining a copy
13
+ of this software and associated documentation files (the "Software"), to deal
14
+ in the Software without restriction, including without limitation the rights
15
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16
+ copies of the Software, and to permit persons to whom the Software is
17
+ furnished to do so, subject to the following conditions:
18
+
19
+ The above copyright notice and this permission notice shall be included in all
20
+ copies or substantial portions of the Software.
21
+
22
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28
+ SOFTWARE.
29
+ Project-URL: Homepage, https://github.com/muhammadsufiyanbaig/simple_vcs/
30
+ Project-URL: Repository, https://github.com/muhammadsufiyanbaig/simple_vcs.git
31
+ Project-URL: Issues, https://github.com/muhammadsufiyanbaig/simple_vcs/issues
32
+ Keywords: version-control,vcs,simple-vcs,backup,snapshot
17
33
  Requires-Python: >=3.7
18
34
  Description-Content-Type: text/markdown
19
35
  License-File: LICENSE
20
36
  Requires-Dist: click>=7.0
21
37
  Dynamic: author
22
- Dynamic: author-email
23
- Dynamic: classifier
24
- Dynamic: description
25
- Dynamic: description-content-type
26
38
  Dynamic: home-page
27
39
  Dynamic: license-file
28
- Dynamic: requires-dist
29
40
  Dynamic: requires-python
30
- Dynamic: summary
31
41
 
32
- # README.md
33
42
  # SimpleVCS
34
43
 
35
44
  A simple version control system written in Python that provides basic VCS functionality similar to Git.
@@ -44,6 +53,10 @@ A simple version control system written in Python that provides basic VCS functi
44
53
  - Repository status tracking
45
54
  - Cross-platform compatibility
46
55
  - Both CLI and Python API support
56
+ - Quick revert to any previous commit
57
+ - Create and restore from snapshots
58
+ - Automatic object compression to save space
59
+ - Simplified workflow compared to Git
47
60
 
48
61
  ## Installation
49
62
 
@@ -56,7 +69,7 @@ pip install simple-vcs
56
69
  ```bash
57
70
  # Clone the repository
58
71
  git clone https://github.com/muhammadsufiyanbaig/simple_vcs.git
59
- cd simple-vcs
72
+ cd simple_vcs
60
73
 
61
74
  # Install in development mode
62
75
  pip install -e .
@@ -136,6 +149,24 @@ svcs diff --c1 1 --c2 3
136
149
  svcs diff --c1 2
137
150
  ```
138
151
 
152
+ #### Advanced Operations
153
+ ```bash
154
+ # Quickly revert to a specific commit
155
+ svcs revert 3
156
+
157
+ # Create a snapshot of current state
158
+ svcs snapshot
159
+
160
+ # Create a named snapshot
161
+ svcs snapshot --name my_backup
162
+
163
+ # Restore from a snapshot
164
+ svcs restore path/to/snapshot.zip
165
+
166
+ # Compress stored objects to save space
167
+ svcs compress
168
+ ```
169
+
139
170
  ### Python API
140
171
 
141
172
  ```python
@@ -162,6 +193,19 @@ vcs.show_diff(1, 2)
162
193
 
163
194
  # Check repository status
164
195
  vcs.status()
196
+
197
+ # Quick revert to a specific commit
198
+ vcs.quick_revert(2)
199
+
200
+ # Create a snapshot of current state
201
+ vcs.create_snapshot()
202
+ vcs.create_snapshot("my_backup")
203
+
204
+ # Restore from a snapshot
205
+ vcs.restore_from_snapshot("my_backup.zip")
206
+
207
+ # Compress stored objects to save space
208
+ vcs.compress_objects()
165
209
  ```
166
210
 
167
211
  ## Advanced Usage
@@ -202,8 +246,8 @@ When initialized, SimpleVCS creates a `.svcs` directory containing:
202
246
  ### Setting up Development Environment
203
247
  ```bash
204
248
  # Clone the repository
205
- git clone https://github.com/yourusername/simple-vcs.git
206
- cd simple-vcs
249
+ git clone https://github.com/muhammadsufiyanbaig/simple_vcs.git
250
+ cd simple_vcs
207
251
 
208
252
  # Create virtual environment
209
253
  python -m venv venv
@@ -267,10 +311,20 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
267
311
 
268
312
  ## Author
269
313
 
270
- Your Name - your.email@example.com
314
+ Muhammad Sufiyan Baig - send.sufiyan@gmail.com
315
+
316
+ Project Link: [https://github.com/muhammadsufiyanbaig/simple_vcs](https://github.com/muhammadsufiyanbaig/simple_vcs)
271
317
 
272
318
  ## Changelog
273
319
 
320
+ ### Version 1.1.0
321
+ - Added quick revert functionality to go back to any commit instantly
322
+ - Added snapshot creation and restoration features
323
+ - Added automatic object compression to save disk space
324
+ - Improved CLI with new commands (revert, snapshot, restore, compress)
325
+ - Enhanced documentation and examples
326
+ - Fixed CLI entry point issue for direct terminal usage
327
+
274
328
  ### Version 1.0.0
275
329
  - Initial release
276
330
  - Basic VCS functionality (init, add, commit, log, diff, status)