reposnap 0.2.1__py3-none-any.whl → 0.2.2__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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: reposnap
3
- Version: 0.2.1
3
+ Version: 0.2.2
4
4
  Summary: Generate a Markdown file with all contents of your project
5
5
  Author: agoloborodko
6
6
  License-File: LICENSE
@@ -18,8 +18,6 @@ Description-Content-Type: text/markdown
18
18
 
19
19
  ## Features
20
20
 
21
- - **Recursive Directory Traversal**: Automatically traverses through all subdirectories of the specified project root.
22
- - **File Exclusion**: Supports excluding specific files and directories using patterns similar to `.gitignore`.
23
21
  - **Syntax Highlighting**: Includes syntax highlighting for known file types in the generated Markdown file.
24
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.
25
23
 
@@ -44,48 +42,29 @@ reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
44
42
  1. **Generate a full project structure with file contents**:
45
43
 
46
44
  ```bash
47
- python -m collect my_project/
45
+ reposnap my_project/
48
46
  ```
49
47
 
50
48
  2. **Generate a project structure only**:
51
49
 
52
50
  ```bash
53
- python -m collect my_project/ --structure-only
51
+ reposnap my_project/ --structure-only
54
52
  ```
55
53
 
56
54
  3. **Generate a Markdown file excluding certain files and directories**:
57
55
 
58
56
  ```bash
59
- python -m collect my_project/ -e '*.log' -e 'build/' -o output.md
60
- ```
61
-
62
- 4. **Use exclusion patterns from a `.gitignore` file**:
63
-
64
- ```bash
65
- python -m collect my_project/ -x .gitignore
57
+ reposnap my_project/ -o output.md
66
58
  ```
67
59
 
68
60
  ## Testing
69
61
 
70
- This project includes unit tests to ensure the correctness of the code:
71
-
72
- - **`test_collect.py`**: Tests the `file_extension_to_language` function, verifying that file extensions are correctly mapped to programming languages for syntax highlighting in the Markdown file.
73
- - **`test_cli.py`**: Tests the command-line interface of the `collect.py` script, including the `--structure-only` flag.
74
-
75
- ### Running the Tests
76
-
77
62
  To run the tests, use `rye`:
78
63
 
79
64
  ```bash
80
65
  rye test
81
66
  ```
82
67
 
83
- This will execute all test cases and provide a summary of the results.
84
-
85
- ## Dependencies
86
-
87
- This project uses standard Python libraries and does not require any external dependencies.
88
-
89
68
  ## License
90
69
 
91
70
  This project is licensed under the MIT License.
@@ -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.1.dist-info/METADATA,sha256=i_TJB734k_ag0j5Qb3FX_YL65F8qhhkyMUvNCHJOazc,2911
12
- reposnap-0.2.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
13
- reposnap-0.2.1.dist-info/entry_points.txt,sha256=EBQ8Fn4zZuWJPPddf_m1LnObGFfcb5OgWeZqzw0O_EE,42
14
- reposnap-0.2.1.dist-info/licenses/LICENSE,sha256=Aj7WCYBXi98pvi723HPn4GDRyjxToNWb3PC6j1_lnPk,1069
15
- reposnap-0.2.1.dist-info/RECORD,,
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,,