reposnap 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

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.
Files changed (7) hide show
  1. reposnap/__init__.py +4 -0
  2. {reposnap-0.2.2.dist-info → reposnap-0.2.4.dist-info}/METADATA +21 -3
  3. {reposnap-0.2.2.dist-info → reposnap-0.2.4.dist-info}/RECORD +6 -6
  4. reposnap-0.2.4.dist-info/entry_points.txt +2 -0
  5. reposnap-0.2.2.dist-info/entry_points.txt +0 -2
  6. {reposnap-0.2.2.dist-info → reposnap-0.2.4.dist-info}/WHEEL +0 -0
  7. {reposnap-0.2.2.dist-info → reposnap-0.2.4.dist-info}/licenses/LICENSE +0 -0
reposnap/__init__.py CHANGED
@@ -0,0 +1,4 @@
1
+ from reposnap.interfaces.cli import main
2
+
3
+ if __name__ == "__main__":
4
+ main()
{reposnap-0.2.2.dist-info → reposnap-0.2.4.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: reposnap
3
- Version: 0.2.2
3
+ Version: 0.2.4
4
4
  Summary: Generate a Markdown file with all contents of your project
5
5
  Author: agoloborodko
6
6
  License-File: LICENSE
@@ -21,11 +21,24 @@ Description-Content-Type: text/markdown
21
21
  - **Syntax Highlighting**: Includes syntax highlighting for known file types in the generated Markdown file.
22
22
  - **Structure Only Option**: The `--structure-only` flag can be used to generate the Markdown file with just the directory structure, omitting the contents of the files.
23
23
 
24
+ ## Installation
25
+ ```bash
26
+ pip install reposnap
27
+ ```
28
+
29
+ Alternatively, you can clone the repository and install the required dependencies:
30
+
31
+ ```bash
32
+ git clone https://github.com/username/reposnap.git
33
+ cd reposnap
34
+ pip install -r requirements.lock
35
+ ```
36
+
24
37
  ## Usage
25
38
 
26
39
  ### Command-Line Interface
27
40
 
28
- To use the `collect.py` script, run it with the following options:
41
+ To use `reposnap`, run it with the following options:
29
42
 
30
43
  ```bash
31
44
  reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
@@ -42,7 +55,7 @@ reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
42
55
  1. **Generate a full project structure with file contents**:
43
56
 
44
57
  ```bash
45
- reposnap my_project/
58
+ reposnap .
46
59
  ```
47
60
 
48
61
  2. **Generate a project structure only**:
@@ -68,3 +81,8 @@ rye test
68
81
  ## License
69
82
 
70
83
  This project is licensed under the MIT License.
84
+
85
+ ## Acknowledgments
86
+
87
+ - [GitPython](https://gitpython.readthedocs.io/) - Used for interacting with Git repositories.
88
+ - [pathspec](https://pathspec.readthedocs.io/) - Used for pattern matching file paths.
{reposnap-0.2.2.dist-info → reposnap-0.2.4.dist-info}/RECORD RENAMED
@@ -1,4 +1,4 @@
1
- reposnap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
1
+ reposnap/__init__.py,sha256=FGadYKcWDEh_AL8PbUuUrcCZDlF510JZfdGhHdT6XQk,80
2
2
  reposnap/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
3
  reposnap/core/collector.py,sha256=TY42k2pN8B9vpuop_g6Dj5PACnr6ncpCYs3b08P1Rog,1253
4
4
  reposnap/core/file_system.py,sha256=X3JdnClpNUqbz_Taj6G3GIozk63wpQ_nG3Jd0yNpxsY,886
@@ -8,8 +8,8 @@ reposnap/interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
8
8
  reposnap/interfaces/cli.py,sha256=3bfyVpVNN5LiuxJ2UxUIpIdNugy75mLpuE-cgjI2J3I,1186
9
9
  reposnap/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
10
10
  reposnap/utils/path_utils.py,sha256=lMuZMMIX2lEE1o6V3QqifmyO5dO5fuA5OUXMxSvYcHI,290
11
- reposnap-0.2.2.dist-info/METADATA,sha256=2ESL-1HA7WntV5eeyvT7yBjHAQ9kRvYN2gFZjsV7iak,1906
12
- reposnap-0.2.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
13
- reposnap-0.2.2.dist-info/entry_points.txt,sha256=EBQ8Fn4zZuWJPPddf_m1LnObGFfcb5OgWeZqzw0O_EE,42
14
- reposnap-0.2.2.dist-info/licenses/LICENSE,sha256=Aj7WCYBXi98pvi723HPn4GDRyjxToNWb3PC6j1_lnPk,1069
15
- reposnap-0.2.2.dist-info/RECORD,,
11
+ reposnap-0.2.4.dist-info/METADATA,sha256=_HWwwMx9j57TYX_Aj_jahtu3LuCcrlBTZ1cupJ04JX4,2329
12
+ reposnap-0.2.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
13
+ reposnap-0.2.4.dist-info/entry_points.txt,sha256=aaCuB0RZOLW2--ymW8VCEOm0Qz9KvTZCUjwQFZsGaDU,43
14
+ reposnap-0.2.4.dist-info/licenses/LICENSE,sha256=Aj7WCYBXi98pvi723HPn4GDRyjxToNWb3PC6j1_lnPk,1069
15
+ reposnap-0.2.4.dist-info/RECORD,,
reposnap-0.2.4.dist-info/entry_points.txt ADDED
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ reposnap = reposnap:main
reposnap-0.2.2.dist-info/entry_points.txt DELETED
@@ -1,2 +0,0 @@
1
- [console_scripts]
2
- reposnap = collect:main