reposnap 0.2.2__tar.gz → 0.2.4__tar.gz

{reposnap-0.2.2 → reposnap-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: reposnap
-Version: 0.2.2
+Version: 0.2.4
 Summary: Generate a Markdown file with all contents of your project
 Author: agoloborodko
 License-File: LICENSE
@@ -21,11 +21,24 @@ Description-Content-Type: text/markdown
 - **Syntax Highlighting**: Includes syntax highlighting for known file types in the generated Markdown file.
 - **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.
 
+## Installation
+```bash
+pip install reposnap
+```
+
+Alternatively, you can clone the repository and install the required dependencies:
+
+```bash
+git clone https://github.com/username/reposnap.git
+cd reposnap
+pip install -r requirements.lock
+```
+
 ## Usage
 
 ### Command-Line Interface
 
-To use the `collect.py` script, run it with the following options:
+To use `reposnap`, run it with the following options:
 
 ```bash
 reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
@@ -42,7 +55,7 @@ reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
 1. **Generate a full project structure with file contents**:
 
     ```bash
-    reposnap my_project/
+    reposnap .
     ```
 
 2. **Generate a project structure only**:
@@ -68,3 +81,8 @@ rye test
 ## License
 
 This project is licensed under the MIT License.
+
+## Acknowledgments
+
+- [GitPython](https://gitpython.readthedocs.io/) - Used for interacting with Git repositories.
+- [pathspec](https://pathspec.readthedocs.io/) - Used for pattern matching file paths.

{reposnap-0.2.2 → reposnap-0.2.4}/README.md

@@ -9,11 +9,24 @@
 - **Syntax Highlighting**: Includes syntax highlighting for known file types in the generated Markdown file.
 - **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.
 
+## Installation
+```bash
+pip install reposnap
+```
+
+Alternatively, you can clone the repository and install the required dependencies:
+
+```bash
+git clone https://github.com/username/reposnap.git
+cd reposnap
+pip install -r requirements.lock
+```
+
 ## Usage
 
 ### Command-Line Interface
 
-To use the `collect.py` script, run it with the following options:
+To use `reposnap`, run it with the following options:
 
 ```bash
 reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
@@ -30,7 +43,7 @@ reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
 1. **Generate a full project structure with file contents**:
 
     ```bash
-    reposnap my_project/
+    reposnap .
     ```
 
 2. **Generate a project structure only**:
@@ -56,3 +69,8 @@ rye test
 ## License
 
 This project is licensed under the MIT License.
+
+## Acknowledgments
+
+- [GitPython](https://gitpython.readthedocs.io/) - Used for interacting with Git repositories.
+- [pathspec](https://pathspec.readthedocs.io/) - Used for pattern matching file paths.

{reposnap-0.2.2 → reposnap-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "reposnap"
-version = "0.2.2"
+version = "0.2.4"
 description = "Generate a Markdown file with all contents of your project"
 authors = [
     { name = "agoloborodko" }
@@ -30,4 +30,4 @@ allow-direct-references = true
 packages = ["src/reposnap"]
 
 [project.scripts]
-reposnap = "collect:main"
+reposnap = "reposnap:main"