reposnap 0.2.3__tar.gz → 0.2.4__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.
Files changed (28) hide show
  1. {reposnap-0.2.3 → reposnap-0.2.4}/PKG-INFO +19 -1
  2. {reposnap-0.2.3 → reposnap-0.2.4}/README.md +18 -0
  3. {reposnap-0.2.3 → reposnap-0.2.4}/pyproject.toml +1 -1
  4. {reposnap-0.2.3 → reposnap-0.2.4}/.gitignore +0 -0
  5. {reposnap-0.2.3 → reposnap-0.2.4}/.python-version +0 -0
  6. {reposnap-0.2.3 → reposnap-0.2.4}/LICENSE +0 -0
  7. {reposnap-0.2.3 → reposnap-0.2.4}/requirements-dev.lock +0 -0
  8. {reposnap-0.2.3 → reposnap-0.2.4}/requirements.lock +0 -0
  9. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/__init__.py +0 -0
  10. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/core/__init__.py +0 -0
  11. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/core/collector.py +0 -0
  12. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/core/file_system.py +0 -0
  13. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/core/git_repo.py +0 -0
  14. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/core/markdown_generator.py +0 -0
  15. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/interfaces/__init__.py +0 -0
  16. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/interfaces/cli.py +0 -0
  17. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/utils/__init__.py +0 -0
  18. {reposnap-0.2.3 → reposnap-0.2.4}/src/reposnap/utils/path_utils.py +0 -0
  19. {reposnap-0.2.3 → reposnap-0.2.4}/tests/__init__.py +0 -0
  20. {reposnap-0.2.3 → reposnap-0.2.4}/tests/reposnap/__init__.py +0 -0
  21. {reposnap-0.2.3 → reposnap-0.2.4}/tests/reposnap/test_cli.py +0 -0
  22. {reposnap-0.2.3 → reposnap-0.2.4}/tests/reposnap/test_collector.py +0 -0
  23. {reposnap-0.2.3 → reposnap-0.2.4}/tests/reposnap/test_file_system.py +0 -0
  24. {reposnap-0.2.3 → reposnap-0.2.4}/tests/reposnap/test_git_repo.py +0 -0
  25. {reposnap-0.2.3 → reposnap-0.2.4}/tests/reposnap/test_markdown_generator.py +0 -0
  26. {reposnap-0.2.3 → reposnap-0.2.4}/tests/reposnap/test_path_utils.py +0 -0
  27. {reposnap-0.2.3 → reposnap-0.2.4}/tests/resources/another_existing_file.py +0 -0
  28. {reposnap-0.2.3 → reposnap-0.2.4}/tests/resources/existing_file.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: reposnap
3
- Version: 0.2.3
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,6 +21,19 @@ 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
@@ -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.
@@ -9,6 +9,19 @@
9
9
  - **Syntax Highlighting**: Includes syntax highlighting for known file types in the generated Markdown file.
10
10
  - **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.
11
11
 
12
+ ## Installation
13
+ ```bash
14
+ pip install reposnap
15
+ ```
16
+
17
+ Alternatively, you can clone the repository and install the required dependencies:
18
+
19
+ ```bash
20
+ git clone https://github.com/username/reposnap.git
21
+ cd reposnap
22
+ pip install -r requirements.lock
23
+ ```
24
+
12
25
  ## Usage
13
26
 
14
27
  ### Command-Line Interface
@@ -56,3 +69,8 @@ rye test
56
69
  ## License
57
70
 
58
71
  This project is licensed under the MIT License.
72
+
73
+ ## Acknowledgments
74
+
75
+ - [GitPython](https://gitpython.readthedocs.io/) - Used for interacting with Git repositories.
76
+ - [pathspec](https://pathspec.readthedocs.io/) - Used for pattern matching file paths.
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "reposnap"
3
- version = "0.2.3"
3
+ version = "0.2.4"
4
4
  description = "Generate a Markdown file with all contents of your project"
5
5
  authors = [
6
6
  { name = "agoloborodko" }
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes