|
| 1 | +# 🐍 Python Docs Punjabi (pa-IN) — Project Report |
| 2 | + |
| 3 | +**Project:** python-docs-pa-in |
| 4 | +**Coordinator:** Bhuvansh Kataria (@BHUVANSH855) |
| 5 | +**Repository:** https://github.com/BHUVANSH855/python-docs-pa-in |
| 6 | +**Report Date:** June 15, 2026 |
| 7 | +**Current Status:** Tutorial Section Complete |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +# Project Overview |
| 12 | + |
| 13 | +The goal of this project is to translate the official Python documentation into Punjabi (Gurmukhi) and make Python learning resources more accessible to Punjabi-speaking students, educators, and developers. |
| 14 | + |
| 15 | +The project follows Python documentation translation guidelines and maintains terminology consistency through a shared glossary, style guide, automated validation, and contributor documentation. |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +# Major Milestones |
| 20 | + |
| 21 | +## Repository Setup |
| 22 | + |
| 23 | +Completed: |
| 24 | + |
| 25 | +* README.md |
| 26 | +* CONTRIBUTING.md |
| 27 | +* STYLE_GUIDE.md |
| 28 | +* GLOSSARY.md |
| 29 | +* GitHub Actions validation workflow |
| 30 | +* Repository restructuring to match Python translation recommendations |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## Community Recognition |
| 35 | + |
| 36 | +### Python Documentation Translation Community |
| 37 | + |
| 38 | +* Introduced project in Python Documentation Translation Discord |
| 39 | +* Received feedback from Stanislav Dzoba (Stan) |
| 40 | +* Dedicated Punjabi translation channel created |
| 41 | +* Added as Punjabi translation coordinator on Transifex |
| 42 | + |
| 43 | +### Transifex |
| 44 | + |
| 45 | +Language Team: Punjabi |
| 46 | + |
| 47 | +Coordinator: |
| 48 | + |
| 49 | +* BHUVANSH855 |
| 50 | + |
| 51 | +Project: |
| 52 | + |
| 53 | +https://app.transifex.com/python-doc/python-newest/ |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +# Tutorial Translation Progress |
| 58 | + |
| 59 | +## Completed Files |
| 60 | + |
| 61 | +| File | Messages | |
| 62 | +| ----------------- | -------: | |
| 63 | +| appetite.po | 17 | |
| 64 | +| interpreter.po | 33 | |
| 65 | +| introduction.po | 120 | |
| 66 | +| controlflow.po | 226 | |
| 67 | +| datastructures.po | 139 | |
| 68 | +| inputoutput.po | 112 | |
| 69 | +| modules.po | 116 | |
| 70 | +| errors.po | 96 | |
| 71 | +| classes.po | 154 | |
| 72 | +| stdlib.po | 67 | |
| 73 | +| stdlib2.po | 65 | |
| 74 | + |
| 75 | +--- |
| 76 | + |
| 77 | +## Translation Statistics |
| 78 | + |
| 79 | +Total Tutorial Files Completed: |
| 80 | + |
| 81 | +```text |
| 82 | +11 / 11 |
| 83 | +``` |
| 84 | + |
| 85 | +Total Translated Messages: |
| 86 | + |
| 87 | +```text |
| 88 | +1145 |
| 89 | +``` |
| 90 | + |
| 91 | +Validation Status: |
| 92 | + |
| 93 | +```text |
| 94 | +All files pass msgfmt --check |
| 95 | +``` |
| 96 | + |
| 97 | +Untranslated Messages: |
| 98 | + |
| 99 | +```text |
| 100 | +0 |
| 101 | +``` |
| 102 | + |
| 103 | +Fuzzy Messages: |
| 104 | + |
| 105 | +```text |
| 106 | +0 |
| 107 | +``` |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +# Git History Milestones |
| 112 | + |
| 113 | +Important translation commits: |
| 114 | + |
| 115 | +```text |
| 116 | +416a7b5 Translate tutorial/classes.po to Punjabi |
| 117 | +e8e7b4a Add Punjabi translation for tutorial stdlib section |
| 118 | +02f4b0c Translate tutorial/stdlib2.po to Punjabi (100%) |
| 119 | +``` |
| 120 | + |
| 121 | +--- |
| 122 | + |
| 123 | +# Repository Tags |
| 124 | + |
| 125 | +```text |
| 126 | +tutorial-phase-1 |
| 127 | +tutorial-complete |
| 128 | +``` |
| 129 | + |
| 130 | +Tag Description: |
| 131 | + |
| 132 | +* tutorial-phase-1 → Initial tutorial milestone |
| 133 | +* tutorial-complete → Entire tutorial section completed |
| 134 | + |
| 135 | +--- |
| 136 | + |
| 137 | +# Quality Assurance |
| 138 | + |
| 139 | +Translation quality is maintained through: |
| 140 | + |
| 141 | +* Manual translation review |
| 142 | +* Shared glossary |
| 143 | +* Style guide enforcement |
| 144 | +* msgfmt validation |
| 145 | +* GitHub Actions automated checks |
| 146 | + |
| 147 | +Validation command: |
| 148 | + |
| 149 | +```bash |
| 150 | +msgfmt --check tutorial/FILENAME.po |
| 151 | +``` |
| 152 | + |
| 153 | +Statistics command: |
| 154 | + |
| 155 | +```bash |
| 156 | +msgfmt --statistics tutorial/FILENAME.po |
| 157 | +``` |
| 158 | + |
| 159 | +--- |
| 160 | + |
| 161 | +# Documentation Assets |
| 162 | + |
| 163 | +## README.md |
| 164 | + |
| 165 | +Contains: |
| 166 | + |
| 167 | +* Project overview |
| 168 | +* Current progress |
| 169 | +* Repository structure |
| 170 | +* Workflow instructions |
| 171 | + |
| 172 | +## CONTRIBUTING.md |
| 173 | + |
| 174 | +Contains: |
| 175 | + |
| 176 | +* Contribution workflow |
| 177 | +* Validation process |
| 178 | +* Translation rules |
| 179 | +* Quality checklist |
| 180 | + |
| 181 | +## STYLE_GUIDE.md |
| 182 | + |
| 183 | +Contains: |
| 184 | + |
| 185 | +* Translation conventions |
| 186 | +* Markup preservation rules |
| 187 | +* Code block handling |
| 188 | +* Consistency guidelines |
| 189 | + |
| 190 | +## GLOSSARY.md |
| 191 | + |
| 192 | +Contains approved Punjabi terminology for Python documentation. |
| 193 | + |
| 194 | +--- |
| 195 | + |
| 196 | +# Current Repository Status |
| 197 | + |
| 198 | +Git Status: |
| 199 | + |
| 200 | +```text |
| 201 | +Working tree clean |
| 202 | +``` |
| 203 | + |
| 204 | +Branch: |
| 205 | + |
| 206 | +```text |
| 207 | +main |
| 208 | +``` |
| 209 | + |
| 210 | +Validation: |
| 211 | + |
| 212 | +```text |
| 213 | +PASS |
| 214 | +``` |
| 215 | + |
| 216 | +Tutorial Section: |
| 217 | + |
| 218 | +```text |
| 219 | +100% Complete |
| 220 | +``` |
| 221 | + |
| 222 | +--- |
| 223 | + |
| 224 | +# Next Objectives |
| 225 | + |
| 226 | +## Short Term |
| 227 | + |
| 228 | +* Upload completed tutorial translations to Transifex |
| 229 | +* Clarify language code usage (pa vs pa-IN) |
| 230 | +* Create first project release |
| 231 | +* Expand project visibility |
| 232 | + |
| 233 | +## Translation Targets |
| 234 | + |
| 235 | +Recommended next files: |
| 236 | + |
| 237 | +1. bugs.po |
| 238 | +2. library/functions.po |
| 239 | +3. library/stdtypes.po |
| 240 | + |
| 241 | +--- |
| 242 | + |
| 243 | +# Project Vision |
| 244 | + |
| 245 | +The long-term goal is to establish a complete Punjabi translation of Python documentation and create a sustainable contributor ecosystem around Punjabi-language programming education. |
| 246 | + |
| 247 | +This project aims to lower barriers for Punjabi-speaking learners and contribute to the broader Python documentation translation effort. |
| 248 | + |
| 249 | +--- |
| 250 | + |
| 251 | +# Report Version |
| 252 | + |
| 253 | +Version: 1.0 |
| 254 | + |
| 255 | +Generated after completion of the entire Tutorial section of the Python documentation translation project. |
0 commit comments