Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 2.84 KB

README.md

File metadata and controls

97 lines (65 loc) · 2.84 KB
Raw

PySensei: Python Learning Assistant

Important

Attention Needed: We are seeking assistance with implementing the following features:

  • Syntax Highlighting for code snippets
  • Responsive Design for better user experience on all devices

For more details, please check out the issue on GitHub: Issue #1

PySensei is an intelligent and interactive Python learning assistant. It helps users learn Python by providing guidance, answering questions, and offering code snippets with explanations. Developed by Zigao Wang, PySensei aims to make Python learning more accessible and engaging.

Features

  • Interactive Conversations: Engage in conversations to learn Python concepts.
  • Code Snippets: Get Python code snippets with explanations.
  • Dark/Light Mode: Toggle between dark and light modes for a comfortable viewing experience.
  • Syntax Highlighting: Code snippets are highlighted for better readability. (Not accomplished yet)
  • Copy to Clipboard: Easily copy code snippets to your clipboard.
  • Responsive Design: Optimized for both desktop and mobile devices. (Not accomplished yet)

Setup

Prerequisites

  • Python 3.6 or higher
  • Flask
  • Prism.js

Installation

  1. Clone the repository:

    git clone https://github.com/pacerclub/pysensei.git
cd pysensei

  2. Install dependencies:

    pip install -r requirements.txt

  3. Run the Flask application:

    python app.py

  4. Open your browser and navigate to:

    http://127.0.0.1:5000

Usage

  1. Start a New Conversation:

    • Click the "+" button to start a new conversation.

  2. Ask a Question:

    • Type your Python-related question in the input box and press "Enter" or click "Ask".

  3. Toggle Dark/Light Mode:

    • Click the sun/moon icon in the header to switch between dark and light modes.

  4. Copy Code Snippets:

    • Click the "Copy" button next to any code snippet to copy it to your clipboard.

  5. Delete a Conversation:

    • Click the trash can icon next to a conversation to delete it.

  6. Toggle Code Mode:

    • Click the code icon in the input area to toggle code mode for better code writing experience.

Contributing

Contributions are welcome! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

Developed by Zigao Wang. Feel free to reach out for any questions or feedback.

Thank you for using PySensei! Happy coding!