https://github.com/sharafatkarim/code-to-docx

A simple python script to make a docx file from multiple files of codes for your presentation.
https://github.com/sharafatkarim/code-to-docx

docx-generator homework python python-script

Last synced: 5 months ago
JSON representation

A simple python script to make a docx file from multiple files of codes for your presentation.

• Host: GitHub
• URL: https://github.com/sharafatkarim/code-to-docx
• Owner: SharafatKarim
• Created: 2023-05-25T16:29:06.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-15T08:55:21.000Z (about 2 years ago)
• Last Synced: 2024-02-15T09:40:54.319Z (about 2 years ago)
• Topics: docx-generator, homework, python, python-script
• Language: Python
• Homepage:
• Size: 16.6 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# File To Docx

A simple Python script to generate a DOCX (Microsoft Word) file from multiple code files for your presentations or assignments.

![code-to-docx](https://socialify.git.ci/SharafatKarim/code-to-docx/image?description=1&descriptionEditable=A+docx+file+from+multiple+files+of+codes+for+your+assignment+or+presentation.&font=KoHo&forks=1&issues=1&language=1&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Auto)

## 🚀 Run Locally

1. **Clone the project**

  ```bash

  git clone https://github.com/SharafatKarim/code-to-docx

  ```

2. **Navigate to the project directory**

  ```bash

  cd code-to-docx

  ```

3. **Create a virtual environment**

  ```bash

  python -m venv .venv

  ```

4. **Activate the virtual environment**

- **Windows**

    ```bash

    .venv\Scripts\activate

    ```

- **Linux or macOS**

    ```bash

    source .venv/bin/activate

    ```

5. **Install dependencies**

  ```bash

  pip install -r requirements.txt

  ```

6. **Place your files in the `input` directory and run the script**

  ```bash

  python main.py

  ```

## 🖥️ GUI Version

A GUI version is available for easy input and output folder selection. Simply run:

```bash

python GUI.py

```

### ✨ New Features

- Add files to `blacklist.txt` to ignore them during processing.

- No need to specify file formats on the first run; the script will automatically search through all files and folders inside `input/`.

```bash

python main.py

```

## 🎥 Sample Video

[Watch a demo for CLI version](https://github.com/SharafatKarim/code-to-docx/assets/93897936/dcdd878a-cbc1-4c28-82c5-416a7a5146bd)

## 👥 Authors

[![SharafatKarim's Profilator](https://profilator.deno.dev/SharafatKarim?v=1.0.0.alpha.4)](https://github.com/SharafatKarim)

[![AyakashiKitsune's Profilator](https://profilator.deno.dev/AyakashiKitsune?v=1.0.0.alpha.4)](https://github.com/AyakashiKitsune)

## 🤝 Contribution

Feel free to fork the repository and open pull requests. Contributions, patches, and advanced versions are welcome—your imagination is the limit!