reposnap 0.2.1__tar.gz → 0.2.3__tar.gz

{reposnap-0.2.1 → reposnap-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: reposnap
-Version: 0.2.1
+Version: 0.2.3
 Summary: Generate a Markdown file with all contents of your project
 Author: agoloborodko
 License-File: LICENSE
@@ -18,8 +18,6 @@ Description-Content-Type: text/markdown
 
 ## Features
 
-- **Recursive Directory Traversal**: Automatically traverses through all subdirectories of the specified project root.
-- **File Exclusion**: Supports excluding specific files and directories using patterns similar to `.gitignore`.
 - **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.
 
@@ -27,7 +25,7 @@ Description-Content-Type: text/markdown
 
 ### 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
@@ -44,48 +42,29 @@ reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
 1. **Generate a full project structure with file contents**:
 
     ```bash
-    python -m collect my_project/
+    reposnap .
     ```
 
 2. **Generate a project structure only**:
 
     ```bash
-    python -m collect my_project/ --structure-only
+    reposnap my_project/ --structure-only
     ```
 
 3. **Generate a Markdown file excluding certain files and directories**:
 
     ```bash
-    python -m collect my_project/ -e '*.log' -e 'build/' -o output.md
-    ```
-
-4. **Use exclusion patterns from a `.gitignore` file**:
-
-    ```bash
-    python -m collect my_project/ -x .gitignore
+    reposnap my_project/ -o output.md
     ```
 
 ## Testing
 
-This project includes unit tests to ensure the correctness of the code:
-
-- **`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.
-- **`test_cli.py`**: Tests the command-line interface of the `collect.py` script, including the `--structure-only` flag.
-
-### Running the Tests
-
 To run the tests, use `rye`:
 
 ```bash
 rye test
 ```
 
-This will execute all test cases and provide a summary of the results.
-
-## Dependencies
-
-This project uses standard Python libraries and does not require any external dependencies. 
-
 ## License
 
 This project is licensed under the MIT License.

{reposnap-0.2.1 → reposnap-0.2.3}/README.md

@@ -6,8 +6,6 @@
 
 ## Features
 
-- **Recursive Directory Traversal**: Automatically traverses through all subdirectories of the specified project root.
-- **File Exclusion**: Supports excluding specific files and directories using patterns similar to `.gitignore`.
 - **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.
 
@@ -15,7 +13,7 @@
 
 ### 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
@@ -32,48 +30,29 @@ reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
 1. **Generate a full project structure with file contents**:
 
     ```bash
-    python -m collect my_project/
+    reposnap .
     ```
 
 2. **Generate a project structure only**:
 
     ```bash
-    python -m collect my_project/ --structure-only
+    reposnap my_project/ --structure-only
     ```
 
 3. **Generate a Markdown file excluding certain files and directories**:
 
     ```bash
-    python -m collect my_project/ -e '*.log' -e 'build/' -o output.md
-    ```
-
-4. **Use exclusion patterns from a `.gitignore` file**:
-
-    ```bash
-    python -m collect my_project/ -x .gitignore
+    reposnap my_project/ -o output.md
     ```
 
 ## Testing
 
-This project includes unit tests to ensure the correctness of the code:
-
-- **`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.
-- **`test_cli.py`**: Tests the command-line interface of the `collect.py` script, including the `--structure-only` flag.
-
-### Running the Tests
-
 To run the tests, use `rye`:
 
 ```bash
 rye test
 ```
 
-This will execute all test cases and provide a summary of the results.
-
-## Dependencies
-
-This project uses standard Python libraries and does not require any external dependencies. 
-
 ## License
 
 This project is licensed under the MIT License.

{reposnap-0.2.1 → reposnap-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "reposnap"
-version = "0.2.1"
+version = "0.2.3"
 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"