Add Python Developer Guide section to documentation portal

[Copilot]

Overview

This PR adds a comprehensive Python Developer Guide section to the documentation portal, providing onboarding and development resources for Python applications within the Easy Software ecosystem.

What's New

A new Python Developer Guide section has been added to the documentation, covering:

📚 Documentation Structure

• Python Developer Guide - Main index page with complete table of contents
• Getting Started - Onboarding guide including:
  • Prerequisites (Teams account, ESko account)
  • SSH key setup for GitLab and ESko
  • IDE configuration for PyCharm and VSCode (with Pylint plugin setup)
• Development - Development workflow instructions:
  • Virtual environment activation
  • FastAPI application startup commands
• Release New Version - Release and deployment procedures:
  • Automated release using x_release.py script
  • Manual release process (branch creation, changelog updates, version.txt)
  • GitLab pipeline execution steps
• Useful Links - Quick reference to:
  • Easy AI chain repository
  • Falcon project
  • Falcon team scrum board
• Azure OpenAI - Placeholder for future Azure OpenAI documentation

🔗 Navigation Integration

The new section is positioned after "End-to-end testing" and before "Release guides" in the documentation portal's navigation menu (toc.json).

Files Added

• docs/Python_tutorials/_index.md
• docs/Python_tutorials/getting_started.md
• docs/Python_tutorials/development.md
• docs/Python_tutorials/release_new_version.md
• docs/Python_tutorials/useful_links.md
• docs/Python_tutorials/azure_openai.md

Files Modified

• toc.json - Added Python Developer Guide section entries

Notes

• All pages include "Back to index" navigation links
• The main index provides both a structured table of contents and TODO markers for future sections (Code Repository and Version Control, Code Standards and Best Practices, Common Libraries and Frameworks, Testing and Debugging, FAQs)
• Documentation follows the existing markdown style and structure conventions used throughout the portal

Original prompt

Add new section for our python applciation: these are our work in progress documentation files:

Python Developer Guide

Welcome to the team! This guide will help you get started with the tools, workflows, and best practices for contributing
effectively to our projects.

---

Table of contents

1. Getting Started
   1. SSH Key Setup
   2. IDE setup
2. Development
3. TODO: Code Repository and Version Control
4. TODO: Code Standards and Best Practices
5. TODO: Common Libraries and Frameworks
6. TODO: Testing and Debugging
7. Deployments and code delivery
   1. Release new version
8. Useful links
9. Azure OpenAI
10. TODO: FAQs

Development

Back to index

Activate virtualenv

source venv/bin/activate

Start the application in development mode

 fastapi dev src/main.py

Getting started

Welcome to the team!

This guide will help you get started with the tools, workflows, and best practices for contributing effectively to our
projects. Back to index

ToC

• Prerequisites
• SSH key setup
• IDE setup
  • PyCharm
    • Installation
    • Configuration
  • VSCode

Prerequisites

List of things that are expected to be done by the time you are reading this document

• Teams account
• ESko account

SSH key setup

Use your existing ssh key https://docs.gitlab.com/ee/user/ssh.html#see-if-you-have-an-existing-ssh-key-pair
or create generate a new one https://docs.gitlab.com/ee/user/ssh.html#generate-an-ssh-key-pair

Add the public key to your gitlab profile https://docs.gitlab.com/ee/user/ssh.html#generate-an-ssh-key-pair

Add the public key to your ESko profile https://es.easyproject.com/my/account.
This key will be used to access servers in our cloud.

IDE setup

PyCharm

Installation

• Install PyCharm directly from the JetBrains website, or you can use Jetbrains toolbox Community Edition
  Should be enough for development. But we are open to professional edition as well.
  • Link to direct download.
  • Link to download JetBrains Toolbox App.

Configuration

• Pylint
  • install pylint plugin in PyCharm
  • go to Settings -> Plugins -> Marketplace -> Pylint -> Install
  • we use this plugin https://plugins.jetbrains.com/plugin/11084-pylint but install it from the IDE

VSCode

• To be added

Deployments and code delivery

Back to index

#ToC:

1. Release new version using a script
2. Release new version manually
3. Continue releasing in gitlab

Release new version using release script

run python x_release.py from this file directory
python cli/x_release.py from GIT root directory
continue with Release in Gitlab section

Release new version manually

Create branch X.Y.Z

# Check out master
git fetch master
# Create a new branch release/X_Y_Z
git checkout -b release/0_8_3 origin/master

Change changelog.md

In changelog.md file, we should add a line with version under ## [Unreleased].

## [Unreleased]

## 0.8.3 - 2024-10-22

Change version.txt

Update version number in version.txt file

Release in Gitlab

1. Create a new merge request with name chore(release): 0.8.3. This name will be used as a name of the commit to
   master.
2. Merge the Merge request
3. Go to Branches -> master
4. On the top of the sources, there is a link to the latest pipeline on the master branch
5. Run the integration_tests job
6. Run the build_production_docker_image job

A new task in esko is automatically created.
You can see the task id at the end of the pipeline log.
For example this one: https://es.easyproject.com/issues/636174

Useful links

List of links one might find useful from time to time.
Back to index

---

Easy AI chain repo: https://git.easy.cz/devel/ai/easy_ai_chain

Falcon project: https://es.easyproject.com/projects/falcon

Falcon team scrum board: https://es.easyproject.com/easy_team_sprint_boards/8

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.