search

ai-trailblazers / signal

AI-powered workflow tool for Slack and Jira integration
MIT License
2 stars 0 forks source link

Setup Python Initial Codebase #1

Closed znas-io closed 8 months ago

znas-io commented 8 months ago

Description: Set up the initial Python codebase to establish a foundation for our project. This task involves creating a basic "Hello World" script that serves as a starting point for further development. Ensure the codebase is organized and ready for additional features.

Acceptance Criteria:

A Python script that outputs "Hello World" is created. The project structure (directories and files) is established and documented. Basic setup instructions are provided in the repository's documentation.

znas-io commented 8 months ago

Hi team. I have created a PR to complete this story, please check it out when you have time. I have added a rule that requires at least one other contributor to review the PR before merging. The following is a summary of the changes I made in this branch:

  1. Integrated GitHub Codespaces:

    • Added support for GitHub Codespaces, allowing contributors to develop directly in the cloud environment.
    • Included a .devcontainer/devcontainer.json file to automatically configure Codespaces for the project.

  2. VSCode Tasks Configuration:

    • Added a .vscode/tasks.json file to define and facilitate the execution of tasks directly within VSCode, streamlining script execution and other common tasks.

  3. Python Environment Management:

    • Adopted pipenv for package management and virtual environment creation, ensuring consistent and reproducible environments for all contributors.
    • Added instructions for setting the PIPENV_VENV_IN_PROJECT environment variable to 1, ensuring that the virtual environment is created at the project's root.

  4. Python Interpreter Configuration in VSCode:

    • Configured VSCode to recognize and suggest the Python interpreter from the pipenv environment, simplifying the setup process for contributors.
    • Provided guidance for manually selecting the Python interpreter within VSCode if automatic detection does not occur.

  5. Project Execution Instructions:

    • Detailed the steps to run the main.py script within the newly established environment, either through terminal commands or VSCode tasks, facilitating easy testing and execution of the project.