PyExampler is a Python-based tool designed to simplify teaching by generating diverse programming examples, making learning engaging and effective. Perfect for educators, self-learners, and Python enthusiasts.

• Generate examples for core programming concepts (variables, loops, functions, and more).
• Simple command-line interface for fast and easy access.
• Platform-independent and customizable for varied teaching needs.

1. Clone the repository:

   git clone https://github.com/erfanrajati/PyExampler.git  
   
   

Welcome to the PyExampler project! This documentation will guide you through two main installation methods (for v1.0):

1. Installing a prebuilt version from the releases
2. Cloning the repository and building it yourself

If you want to quickly set up and use PyExampler, you can download the prebuilt version from the Releases section of this repository. Follow these simple steps:

1. Download the PyExampler v1.0 release zip file from the Releases section. It contains the following files:

   • addpath.exe
   • PyExampler.exe
   • python_guide_examples.json

2. Extract the contents of the zip file to a folder on your machine.

3. Add PyExampler to System Path:

   • Double-click on the addpath.exe file. This will automatically add PyExampler to your system's PATH environment variable, making it easy to run from any terminal.

4. Cleanup:

   • Once the path is successfully added, it is recommended to delete the addpath.exe file to keep your installation clean.

5. Running the Program:

   • After this, you can simply open the Windows Terminal or Command Prompt and type:

     PyExampler
     

   • The program will start, and you're ready to enjoy!

If you want to clone the repository and build the application yourself, follow the steps below:

First, clone the repository using the following command:

git clone https://github.com/erfanrajati/PyExampler.git

The project requires PyInstaller to create a standalone executable. Install it using:

pip install pyinstaller

To build PyExampler, execute the following PyInstaller command:

pyinstaller --onefile --name PyExampler --add-data "C:\path\to\python\site-packages\pyfiglet\fonts;pyfiglet/fonts" --workpath ./PyExampler_build/build --distpath ./PyExampler_build/dist --specpath ./PyExampler_build main.py

• Replace C:\path\to\python\site-packages\pyfiglet\fonts with the actual path to the pyfiglet/fonts on your system.

The final build (the PyExampler.exe file) will be located in the following directory:

\PyExampler\PyExampler_build\dist\

The program requires the python_guide_examples.json file to run. Ensure this file is in the same directory as the PyExampler.exe file.

For the best experience, you can add the PyExampler executable to your system path. The repository provides a helpful script located in the /install directory.

To add PyExampler to your system path:

1. Move the addpath.py script from the /install directory into the same folder where PyExampler.exe and python_guide_examples.json are located.
2. Run the script:

   python addpath.py

This will add PyExampler to the system path, allowing you to run it from any terminal.

Once the build is complete and the path is added, you can run PyExampler by opening a terminal and typing:

PyExampler

The program will start, and you're good to go!

Thank you for using PyExampler! If you run into any issues or have questions, feel free to open an issue on the GitHub repository.