Proj Parser is a command-line tool for generating a visual representation of directory structures while allowing for customizable exclusions via the ability to update a settings file, either manually or through the command-line tool.
If you'd like the executable directly, without the need to build, switch to the compiled branch in this repository and download the executable directly.
On the other hand, if you want to build the project yourself, these instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Python 3.9 or newer
- PyInstaller (for building the executable)
To run the tests in Visual Studio Code, follow these steps:
- Open the Command Palette (Ctrl+Shift+P).
- Type
Python: Discover Tests. - Choose
unittestas the testing framework. - Configure the test directory to
./tests. - Click the
Run Testsicon in the left sidebar.
To build the executable with PyInstaller in the Visual Studio Code command line:
- Open the terminal in Visual Studio Code and make sure you're in the root folder of the project.
- Run the following command:
pyinstaller --onefile main.py- The executable will be located in the
distdirectory.
If you haven't installed PyInstaller yet, you can do so using pip:
pip install pyinstallerIf you encounter a ModuleNotFoundError, ensure that your Python interpreter is correctly set up in Visual Studio Code and that all dependencies are installed in the environment you're using.
Make sure your test files are located in the ./tests directory and prefixed with test_. Ensure that unittest discovery settings in Visual Studio Code are correctly configured as mentioned in the "Running the Tests" section.
Contributions are always welcome, simple as that! Feel free to fork the repository, make changes, and then submit a pull request to the target branch with your proposed changes.
This work is licensed under the terms of the MIT license. For a copy, see https://opensource.org/licenses/MIT.