commit 5fb0909e8dd8f321008c943012595deb64da87d5 Author: Astound Date: Sun Oct 26 23:39:49 2025 -0500 initial commit diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..b74f04d --- /dev/null +++ b/.dockerignore @@ -0,0 +1,86 @@ +# Git +.git +.gitignore + +# Python +__pycache__ +*.pyc +*.pyo +*.pyd +.Python +pip-log.txt +pip-delete-this-directory.txt +.tox +.pytest_cache +nosetests.xml +.cache + +# Virtual environments +venv/ +env/ +ENV/ +.venv/ + +# IDEs +.vscode/ +.idea/ +*.swp +*.swo + +# OS +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db + +# Tests and coverage (not needed in production) +tests/ +htmlcov/ +.coverage +.coverage.* +coverage.xml +*.cover + +# Development scripts (not needed in production) +scripts/ + +# Docker files +Dockerfile +docker-compose.yml +docker-compose.dev.yml +.dockerignore + +# Documentation (optional in production) +README.md +CHANGELOG.md +LICENSE +docs/ + +# Development dependencies and tools +requirements-dev.txt +Makefile +.flake8 +pytest.ini +pyproject.toml + +# Backup files +*.backup +*.bak +data/*.backup + +# Environment files (use environment variables in Docker) +.env* + +# Temporary files and logs +*.tmp +*.temp +temp/ +tmp/ +logs/ +*.log + +# Version files +_version.py diff --git a/.env.sample b/.env.sample new file mode 100644 index 0000000..a1ad113 --- /dev/null +++ b/.env.sample @@ -0,0 +1,140 @@ +# ==================================== +# CONFIGURACIÓN DE ENTORNO - BALOTARIO LICENCIA A-I +# ==================================== +# Copia este archivo como .env y ajusta los valores según tu entorno + +# ==================================== +# CONFIGURACIÓN DE FLASK +# ==================================== + +# Clave secreta para Flask (CAMBIAR EN PRODUCCIÓN) +# Genera una nueva con: python -c "import secrets; print(secrets.token_hex(32))" +SECRET_KEY=balotario_secret_key_2024_super_secure + +# Entorno de ejecución (development, production, testing) +FLASK_ENV=development + +# Configuración específica de Flask +FLASK_CONFIG=development + +# Modo debug (true/false) +FLASK_DEBUG=true + +# ==================================== +# CONFIGURACIÓN DE LA APLICACIÓN +# ==================================== + +# Puerto de la aplicación (por defecto: 5000) +PORT=5000 + +# Host de la aplicación (por defecto: 0.0.0.0 para Docker, 127.0.0.1 para local) +HOST=127.0.0.1 + +# ==================================== +# CONFIGURACIÓN DE DOCKER +# ==================================== + +# Indica si la aplicación se ejecuta en Docker +DOCKER_CONTAINER=false + +# ==================================== +# CONFIGURACIÓN DE BASE DE DATOS (FUTURO) +# ==================================== +# Descomenta y configura si planeas agregar una base de datos + +# DATABASE_URL=sqlite:///balotario.db +# DB_HOST=localhost +# DB_PORT=5432 +# DB_NAME=balotario +# DB_USER=balotario_user +# DB_PASSWORD=secure_password + +# ==================================== +# CONFIGURACIÓN DE LOGGING +# ==================================== + +# Nivel de logging (DEBUG, INFO, WARNING, ERROR, CRITICAL) +LOG_LEVEL=INFO + +# Archivo de logs (opcional) +# LOG_FILE=logs/balotario.log + +# ==================================== +# CONFIGURACIÓN DE SEGURIDAD +# ==================================== + +# Configuración CORS (si es necesario) +# CORS_ORIGINS=http://localhost:3000,http://localhost:8080 + +# Configuración de rate limiting (si se implementa) +# RATE_LIMIT_ENABLED=true +# RATE_LIMIT_REQUESTS=100 +# RATE_LIMIT_WINDOW=3600 + +# ==================================== +# CONFIGURACIÓN DE CACHE (FUTURO) +# ==================================== +# Descomenta si planeas agregar Redis u otro sistema de cache + +# REDIS_URL=redis://localhost:6379/0 +# CACHE_TYPE=redis +# CACHE_DEFAULT_TIMEOUT=300 + +# ==================================== +# CONFIGURACIÓN DE EMAIL (FUTURO) +# ==================================== +# Descomenta si planeas agregar funcionalidad de email + +# MAIL_SERVER=smtp.gmail.com +# MAIL_PORT=587 +# MAIL_USE_TLS=true +# MAIL_USERNAME=tu-email@gmail.com +# MAIL_PASSWORD=tu-password-de-aplicacion + +# ==================================== +# CONFIGURACIÓN DE ANALYTICS (FUTURO) +# ==================================== +# Descomenta si planeas agregar Google Analytics u otros + +# GOOGLE_ANALYTICS_ID=GA_MEASUREMENT_ID +# ENABLE_ANALYTICS=false + +# ==================================== +# CONFIGURACIÓN DE DESARROLLO +# ==================================== + +# Recargar automáticamente en cambios (solo desarrollo) +AUTO_RELOAD=true + +# Mostrar errores detallados (solo desarrollo) +SHOW_DEBUG_TOOLBAR=false + +# ==================================== +# CONFIGURACIÓN DE PRODUCCIÓN +# ==================================== +# Variables específicas para entorno de producción + +# Dominio de la aplicación +# DOMAIN=tu-dominio.com + +# Configuración SSL +# SSL_ENABLED=false +# SSL_CERT_PATH=/path/to/cert.pem +# SSL_KEY_PATH=/path/to/key.pem + +# ==================================== +# CONFIGURACIÓN DE MONITOREO (FUTURO) +# ==================================== +# Descomenta si planeas agregar monitoreo + +# SENTRY_DSN=https://your-sentry-dsn +# ENABLE_MONITORING=false + +# ==================================== +# NOTAS IMPORTANTES +# ==================================== +# 1. NUNCA subas el archivo .env al repositorio +# 2. Cambia SECRET_KEY en producción +# 3. Usa valores seguros para passwords +# 4. Revisa que .env esté en .gitignore +# 5. Para Docker, algunas variables se sobrescriben en docker-compose.yml diff --git a/.gitea/workflows/release.yaml b/.gitea/workflows/release.yaml new file mode 100644 index 0000000..d3af049 --- /dev/null +++ b/.gitea/workflows/release.yaml @@ -0,0 +1,47 @@ +name: release + +on: + schedule: + - cron: '0 10 * * *' + push: + branches: + - main + +jobs: + release-default: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker BuildX + uses: docker/setup-buildx-action@v3 + + - name: Login to DockerHub + uses: docker/login-action@v3 + with: + username: ${{ secrets.DOCKER_REGISTRY_USER }} + password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }} + + - name: Check syntax docker + uses: hadolint/hadolint-action@v3.1.0 + with: + dockerfile: Dockerfile + ignore: DL3013,DL3008,DL4006 + + - name: Push Docker image + uses: docker/build-push-action@v6 + with: + context: . + file: Dockerfile + platforms: | + linux/amd64 + linux/arm64 + push: true + no-cache: false + tags: | + ${{ secrets.DOCKER_REGISTRY_USER}}/driving-academy:${{ github.sha }} + ${{ secrets.DOCKER_REGISTRY_USER}}/driving-academy:latest diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..89b6277 --- /dev/null +++ b/.gitignore @@ -0,0 +1,187 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# IDEs +.vscode/ +.idea/ +*.swp +*.swo +*~ + +# OS generated files +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db + +# Logs +*.log +logs/ + +# Temporary files +*.tmp +*.temp +temp/ +tmp/ + +# Application specific +*.db +*.sqlite +*.sqlite3 +session_data/ +uploads/ + +# Backup files +*.backup +*.bak +data/*.backup + +# Environment files (keep .env.sample) +.env +.env.local +.env.development +.env.production + +# Coverage reports +htmlcov/ +.coverage +coverage.xml +*.cover + +# Development tools +.flake8 +pytest.ini +pyproject.toml + +# Version files +_version.py diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..b4a5e0f --- /dev/null +++ b/Dockerfile @@ -0,0 +1,44 @@ +# Use official Python Alpine base image +FROM python:3.11-alpine + +# Maintainer information +LABEL maintainer="Balotario Licencia A-I" +LABEL description="Interactive web application to study driving license test questions" +LABEL version="1.0.0" + +# Set working directory +WORKDIR /app + +# Update system packages for security (CVEs) +RUN apk update && apk upgrade --no-cache && \ + rm -rf /var/cache/apk/* + +# Copy dependency files +COPY requirements.txt . + +# Install Python dependencies +RUN pip install --no-cache-dir --upgrade pip && \ + pip install --no-cache-dir -r requirements.txt + +# Copy application code +COPY . . + +# Create non-root user for security +RUN adduser -D -s /bin/sh app && \ + chown -R app:app /app +USER app + +# Expose port +EXPOSE 5000 + +# Environment variables +ENV FLASK_APP=app.py +ENV FLASK_ENV=production +ENV PYTHONPATH=/app + +# Docker health check command +HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \ + CMD wget --no-verbose --tries=1 --spider http://localhost:5000/ || exit 1 + +# Default command +CMD ["python", "run.py"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..db2287e --- /dev/null +++ b/Makefile @@ -0,0 +1,83 @@ +# Makefile for Flask Balotario Application +# Provides convenient commands for development and deployment + +.PHONY: help install install-dev install-test clean test lint format run docker-build docker-run + +# Default target +help: + @echo "Available commands:" + @echo " install - Install production dependencies" + @echo " install-dev - Install development dependencies" + @echo " clean - Clean up cache and temporary files" + @echo " test - Run tests with coverage" + @echo " lint - Run linting checks" + @echo " format - Format code with black and isort" + @echo " security - Run security checks" + @echo " run - Run development server" + @echo " run-prod - Run production server with gunicorn" + @echo " docker-build - Build Docker image" + @echo " docker-run - Run Docker container" + @echo " download-images - Download all images locally" + @echo " verify-images - Verify all images are available" + +# Installation targets +install: + pip install -r requirements.txt + +install-dev: + pip install -r requirements-dev.txt + +# Development targets +clean: + find . -type f -name "*.pyc" -delete + find . -type d -name "__pycache__" -delete + find . -type d -name "*.egg-info" -exec rm -rf {} + + rm -rf .pytest_cache + rm -rf .coverage + rm -rf htmlcov/ + +test: + pytest --cov=. --cov-report=html --cov-report=term-missing + +lint: + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + +format: + black . + isort . + +security: + bandit -r . -x tests/ + safety check + +# Server targets +run: + python app.py + +run-prod: + gunicorn --bind 0.0.0.0:5000 --workers 4 app:app + +# Docker targets +docker-build: + docker build -t driving-academy . + +docker-run: + docker run -p 5000:5000 driving-academy + +# Image management +download-images: + python scripts/download_images.py + +verify-images: + python scripts/verify_images.py + +# Development setup (complete environment) +setup-dev: install-dev download-images + @echo "Development environment ready!" + @echo "Run 'make run' to start the development server" + +# Production setup +setup-prod: install + @echo "Production environment ready!" + @echo "Run 'make run-prod' to start the production server" diff --git a/README.md b/README.md new file mode 100644 index 0000000..0391eaf --- /dev/null +++ b/README.md @@ -0,0 +1,273 @@ +# 🚗 Balotario Licencia Clase A - Categoría I + +Una aplicación web interactiva desarrollada con Flask para estudiar las preguntas del balotario oficial de la licencia de conducir Clase A - Categoría I del Perú. + +## ✨ Características + +- **📚 Modo Estudio**: Revisa todas las preguntas con sus respuestas correctas +- **🏋️ Modo Práctica**: Practica con preguntas aleatorias y retroalimentación inmediata +- **📝 Examen Simulado**: Simula el examen real con tiempo limitado +- **📊 Estadísticas**: Seguimiento de tu progreso y precisión +- **🖼️ Imágenes**: Incluye todas las señales de tránsito oficiales +- **📱 Responsive**: Funciona perfectamente en móviles y tablets +- **🎨 Interfaz Moderna**: Diseño atractivo y fácil de usar + +## 🚀 Instalación y Configuración + +### 🐳 Opción 1: Docker (Recomendado) +```bash +# Clonar el repositorio +git clone +cd balotario-licencia-a1 + +# Opción A: Docker Compose (más fácil) +docker-compose up -d + +# Opción B: Docker simple +docker build -t balotario . +docker run -p 5000:5000 balotario + +# Opción C: Script de utilidades +./scripts/docker.sh compose-up +``` + +### 🐍 Opción 2: Instalación Local + +#### Prerrequisitos +- Python 3.7 o superior +- pip (gestor de paquetes de Python) + +#### Pasos de instalación + +1. **Clona o descarga el proyecto** + ```bash + # Si tienes git instalado + git clone + cd balotario-licencia-a1 + ``` + +2. **Configura las variables de entorno** + ```bash + # Linux/Mac + ./scripts/env-setup.sh dev + + # Windows + scripts\env-setup.bat dev + + # O manualmente + cp .env.sample .env + # Edita .env con tus valores + ``` + +3. **Instala las dependencias** + ```bash + pip install -r requirements.txt + ``` + +4. **Ejecuta la aplicación** + ```bash + python run.py + ``` + +5. **Abre tu navegador** + - Ve a: `http://localhost:5000` + - ¡Listo para estudiar! 🎉 + +### 🌐 Acceso +- **Docker**: `http://localhost:5000` (o `http://localhost` con Nginx) +- **Local**: `http://localhost:5000` + +## ⚙️ Configuración de Variables de Entorno + +### 🔧 Configuración Rápida +```bash +# Desarrollo local +./scripts/env-setup.sh dev + +# Producción +./scripts/env-setup.sh prod + +# Docker +./scripts/env-setup.sh docker +``` + +### 📋 Variables Principales +| Variable | Descripción | Por Defecto | +|----------|-------------|-------------| +| `SECRET_KEY` | Clave secreta de Flask | `balotario_secret_key_2024_super_secure` | +| `FLASK_ENV` | Entorno de ejecución | `development` | +| `FLASK_DEBUG` | Modo debug | `true` | +| `HOST` | Dirección del servidor | `127.0.0.1` | +| `PORT` | Puerto del servidor | `5000` | + +### 📚 Documentación Completa +Ver [docs/ENVIRONMENT.md](docs/ENVIRONMENT.md) para configuración avanzada. + +## 📖 Cómo usar la aplicación + +### 🏠 Página Principal +- Resumen de estadísticas +- Acceso rápido a todos los modos +- Información del balotario + +### 📚 Modo Estudio +- Navega por todas las preguntas secuencialmente +- Filtra por rango de preguntas +- Muestra/oculta respuestas correctas +- Navegación con teclado (flechas y espacio) + +### 🏋️ Modo Práctica +- Selecciona el número de preguntas (10, 20, 30, 50) +- Preguntas aleatorias +- Retroalimentación inmediata +- Estadísticas de sesión + +### 📝 Examen Simulado +- Configura número de preguntas y tiempo límite +- Cronómetro en tiempo real +- Navegador de preguntas +- Calificación final con porcentaje de aprobación + +## 🛠️ Estructura del Proyecto + +``` +balotario-licencia-a1/ +├── app.py # Aplicación Flask principal +├── run_app.py # Script de inicio mejorado +├── config.py # Configuración modular +├── requirements.txt # Dependencias Python +├── data/ # Datos y contenido +│ ├── balotario_clase_a_cat_I.md # 200 preguntas oficiales +│ ├── README.md # Documentación del contenido +│ └── backup/ # Respaldos del contenido +├── templates/ # Templates HTML +│ ├── base.html # Template base +│ ├── index.html # Página principal +│ ├── study.html # Modo estudio +│ ├── practice.html # Modo práctica +│ └── exam.html # Examen simulado +├── static/ # Archivos estáticos +│ ├── css/ +│ │ └── custom.css # Estilos personalizados +│ └── js/ +│ └── app.js # JavaScript principal +├── test/ # Tests y pruebas +│ ├── README.md # Documentación de tests +│ ├── test_parser.py # Tests del parser +│ ├── test_sounds.html # Tests de sonidos +│ └── ... # Otros tests +├── scripts/ # Scripts de utilidades +│ └── dev.py # Herramientas de desarrollo +├── CHANGELOG.md # Registro de cambios +├── INSTALL.md # Guía de instalación +└── README.md # Esta documentación +``` + +## 🎯 Funcionalidades Técnicas + +### Backend (Flask) +- **API RESTful** para obtener preguntas +- **Sesiones** para estadísticas persistentes +- **Parser inteligente** del markdown con regex +- **Filtros dinámicos** por rango y modo + +### Frontend +- **Bootstrap 5** para diseño responsive +- **jQuery** para interactividad +- **Font Awesome** para iconos +- **Animaciones CSS** para mejor UX +- **LocalStorage** para persistencia del lado cliente + +### Características Especiales +- **Navegación por teclado** en modo estudio +- **Cronómetro visual** en examen simulado +- **Navegador de preguntas** con estado visual +- **Estadísticas en tiempo real** +- **Confirmación antes de finalizar examen** + +## 📊 Datos del Balotario + +- **200 preguntas** oficiales +- **Respuestas correctas** marcadas con ✅ +- **Imágenes de señales** de tránsito incluidas +- **Categorías**: Reglamentarias, preventivas, informativas +- **Temas**: Normas de tránsito, señalización, seguridad vial + +## 🔧 Personalización + +### Modificar preguntas +Edita el archivo `balotario_clase_a_cat_I.md` siguiendo el formato: + +```markdown +### [NÚMERO] + +[PREGUNTA] + +a) [OPCIÓN A] +b) [OPCIÓN B] +c) [OPCIÓN C] +✅ d) [OPCIÓN CORRECTA] +``` + +### Cambiar estilos +Los estilos CSS están en `templates/base.html` dentro de la etiqueta ` + + + + + +
+
+ {% block content %}{% endblock %} +
+
+ + + + + + + + + + + + + + + {% block scripts %}{% endblock %} + + + diff --git a/templates/exam.html b/templates/exam.html new file mode 100644 index 0000000..cbec749 --- /dev/null +++ b/templates/exam.html @@ -0,0 +1,329 @@ +{% extends "base.html" %} + +{% block title %}Examen Simulado - Balotario Licencia A-I{% endblock %} + +{% block content %} +
+

+ + Examen Simulado +

+

Simula el examen real con tiempo limitado y obtén tu calificación final

+
+ +
+
+
+
+
+ Configuración del Examen +
+ +
+
+ + +
+
+ + +
+
+ +
+ + Instrucciones: +
    +
  • Responde todas las preguntas antes de que se acabe el tiempo
    • +
  • Puedes navegar entre preguntas usando los botones
    • +
  • Las preguntas no respondidas se marcarán como incorrectas
    • +
  • Al finalizar verás tu calificación y las respuestas correctas
    • +
+
+ +
+ +
+
+
+
+
+ + + + + + + + + +{% endblock %} + +{% block scripts %} + +{% endblock %} diff --git a/templates/index.html b/templates/index.html new file mode 100644 index 0000000..27410cd --- /dev/null +++ b/templates/index.html @@ -0,0 +1,269 @@ +{% extends "base.html" %} + +{% block content %} +
+

+ + Balotario Licencia Clase A - Categoría I +

+

Prepárate para tu examen de manejo con {{ total_questions }} preguntas oficiales del MTC +

+
+ +
+
+
+
+
+ +
+
Modo Estudio
+

+ Revisa todas las preguntas con sus respuestas correctas. Perfecto para aprender. +

+ + Comenzar a Estudiar + +
+
+
+ +
+
+
+
+ +
+
Modo Práctica
+

+ Practica con preguntas aleatorias y recibe retroalimentación inmediata. +

+ + Practicar Ahora + +
+
+
+ +
+
+
+
+ +
+
Examen Simulado
+

+ Simula el examen real con tiempo limitado y obtén tu calificación final. +

+ + Tomar Examen + +
+
+
+ +
+
+
+
+ +
+
Estadísticas
+
+
+
+
+

0

+ Respondidas +
+
+

0%

+ Precisión +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+ +
+
+
+
+
+ + Información del Balotario +
+
+
+
    +
  • {{ total_questions }} preguntas oficiales +
    • +
  • Respuestas correctas marcadas
    • +
  • Imágenes de señales de tránsito
    • +
  • Seguimiento de progreso
    • +
+
+
+
    +
  • Interfaz intuitiva y moderna
    • +
  • Modo examen con cronómetro
    • +
  • Estadísticas detalladas
    • +
  • Responsive para móviles
    • +
+
+
+
+
+
+
+ + + + + +{% endblock %} + +{% block scripts %} + +{% endblock %} diff --git a/templates/practice.html b/templates/practice.html new file mode 100644 index 0000000..9d76c60 --- /dev/null +++ b/templates/practice.html @@ -0,0 +1,217 @@ +{% extends "base.html" %} + +{% block title %}Modo Práctica - Balotario Licencia A-I{% endblock %} + +{% block content %} +
+

+ + Modo Práctica +

+

Practica con preguntas aleatorias y recibe retroalimentación inmediata

+
+ +
+
+
+
+
+
Configuración de Práctica
+ +
+
+
+ + +
+
+ + +
+
+
+
+
+
+
+
+
Estadísticas de Sesión
+
+
+
0
+ Correctas +
+
+
0
+ Incorrectas +
+
+
0%
+ Precisión +
+
+
+
+
+
+
+
+
+
+
+ +
+ +
+ + + + + +
+
+
+ +

¡Listo para Practicar!

+

Configura tu sesión de práctica y comienza a responder preguntas aleatorias.

+

+ + Tip: Recibirás retroalimentación inmediata después de cada respuesta. +

+
+
+
+ + +{% endblock %} + +{% block scripts %} + +{% endblock %} diff --git a/templates/study.html b/templates/study.html new file mode 100644 index 0000000..adceefe --- /dev/null +++ b/templates/study.html @@ -0,0 +1,287 @@ +{% extends "base.html" %} + +{% block title %}Modo Estudio - Balotario Licencia A-I{% endblock %} + +{% block content %} +
+

+ + Modo Estudio +

+

Revisa todas las preguntas con sus respuestas correctas

+
+ +
+
+
+
+
+
Filtros de Estudio
+ +
+
+
+ + +
+
+ + +
+
+ + +
+
+
+
+
+
+
+
+
Progreso de Estudio
+
+
+

1

+ Pregunta Actual +
+
+

0

+ Total +
+
+
+
+
+
+
+
+
+ +
+ +
+ + + + + + +{% endblock %} + +{% block scripts %} + +{% endblock %} diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000..a4796ae --- /dev/null +++ b/tests/README.md @@ -0,0 +1,138 @@ +# 🧪 Tests del Balotario Licencia A-I + +Este directorio contiene tests automatizados para verificar el funcionamiento correcto de la aplicación Flask. + +## 📁 Archivos de Test + +### 🐍 Tests Automatizados con pytest + +#### `test_app.py` +- **Propósito**: Tests completos de la aplicación Flask +- **Verifica**: + - Páginas web (index, study, practice, exam) + - API endpoints (/api/questions) + - Estructura de datos de preguntas + - Archivos estáticos (CSS, JS, favicon) + +#### `test_parser.py` +- **Propósito**: Tests del parser de markdown +- **Verifica**: + - Parsing correcto de preguntas, opciones y respuestas + - Soporte para imágenes locales y remotas + - Estructura de datos válida + +#### `test_clean_parser.py` +- **Propósito**: Tests de limpieza de emojis ✅ +- **Verifica**: Eliminación correcta de marcadores visuales + +#### `conftest.py` +- **Propósito**: Configuración global de pytest +- **Contiene**: Fixtures para cliente Flask y configuración de tests + +## 🚀 Cómo Ejecutar los Tests + +### Opción 1: Usando Makefile (Recomendado) +```bash +# Ejecutar todos los tests con cobertura +make test + +# Instalar dependencias de desarrollo +make install-dev +``` + +### Opción 2: Usando pytest directamente +```bash +# Activar entorno virtual +source venv/bin/activate # Linux/Mac +# o +venv\Scripts\activate # Windows + +# Ejecutar todos los tests +pytest + +# Con cobertura detallada +pytest --cov=. --cov-report=html --cov-report=term-missing + +# Ejecutar tests específicos +pytest tests/test_app.py +pytest tests/test_parser.py +``` + +### Ver Reporte de Cobertura +```bash +# Abrir reporte HTML (se genera automáticamente) +open htmlcov/index.html # Mac +xdg-open htmlcov/index.html # Linux +start htmlcov/index.html # Windows +``` + +## 📊 Cobertura de Tests + +### ✅ Funcionalidades Probadas (15 tests) +- [x] **Páginas web**: Index, Study, Practice, Exam +- [x] **API endpoints**: /api/questions con diferentes modos +- [x] **Parser de markdown**: Preguntas, opciones, respuestas correctas +- [x] **Imágenes**: Soporte local y remoto +- [x] **Archivos estáticos**: CSS, JS, favicon +- [x] **Validación de datos**: Estructura de preguntas +- [x] **Manejo de errores**: Parámetros inválidos +- [x] **Limpieza de emojis**: Eliminación de marcadores ✅ + +### 📈 Estadísticas Actuales +- **Tests**: 15 pasando ✅ +- **Cobertura**: ~67% del código +- **Archivos cubiertos**: app.py (82%), config.py (100%) + +### 🔄 Posibles Mejoras Futuras +- [ ] Tests de JavaScript (frontend) +- [ ] Tests de integración completa +- [ ] Tests de rendimiento +- [ ] Tests de accesibilidad +- [ ] Tests de responsive design + +## 🛠️ Desarrollo de Tests + +### Agregar Nuevos Tests +1. Crear archivo `test_[funcionalidad].py` en el directorio `tests/` +2. Usar las fixtures de `conftest.py` (client, app) +3. Seguir el patrón de naming: `test_[descripcion]()` +4. Documentar en este README + +### Convenciones +- **Naming**: `test_[funcionalidad]_[caso]()` +- **Assertions**: Usar `assert` con mensajes descriptivos +- **Fixtures**: Reutilizar `client` y `app` de conftest.py +- **Docstrings**: Describir qué verifica cada test + +### Ejemplo de Test +```python +def test_new_feature(client): + """Test that new feature works correctly.""" + response = client.get('/new-endpoint') + assert response.status_code == 200 + assert b'expected content' in response.data +``` + +## 🐛 Debugging + +### Si un Test Falla +1. **Leer el mensaje de error** completo +2. **Ejecutar test individual**: `pytest tests/test_app.py::test_specific_function -v` +3. **Verificar fixtures**: Asegurar que `conftest.py` esté correcto +4. **Revisar imports**: Verificar que los módulos se importen correctamente + +### Comandos Útiles +```bash +# Test específico con output detallado +pytest tests/test_app.py::test_index_page -v -s + +# Parar en el primer fallo +pytest -x + +# Mostrar variables locales en fallos +pytest --tb=long +``` + +--- + +**Nota**: Estos son tests automatizados que se ejecutan con pytest. Proporcionan verificación continua de que la aplicación funciona correctamente. diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..74be3cf --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,33 @@ +""" +Pytest configuration and fixtures +""" + +import sys +import os +import pytest + +# Add the parent directory to the Python path so we can import the app +sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) + +from app import app as flask_app + + +@pytest.fixture +def app(): + """Create and configure a new app instance for each test.""" + flask_app.config['TESTING'] = True + flask_app.config['WTF_CSRF_ENABLED'] = False + + yield flask_app + + +@pytest.fixture +def client(app): + """A test client for the app.""" + return app.test_client() + + +@pytest.fixture +def runner(app): + """A test runner for the app's Click commands.""" + return app.test_cli_runner() diff --git a/tests/test_app.py b/tests/test_app.py new file mode 100644 index 0000000..6247bc5 --- /dev/null +++ b/tests/test_app.py @@ -0,0 +1,184 @@ +#!/usr/bin/env python3 +""" +Tests for the Flask application +""" + +import pytest +import json +# Fixtures are imported from conftest.py + + +def test_index_page(client): + """Test that the index page loads correctly.""" + response = client.get('/') + assert response.status_code == 200 + assert b'Balotario Licencia Clase A' in response.data + assert b'Estudiar' in response.data + assert b'Practicar' in response.data + assert b'Examen' in response.data + + +def test_study_page(client): + """Test that the study page loads correctly.""" + response = client.get('/study') + assert response.status_code == 200 + assert b'Modo Estudio' in response.data + + +def test_practice_page(client): + """Test that the practice page loads correctly.""" + response = client.get('/practice') + assert response.status_code == 200 + assert b'Modo Pr\xc3\xa1ctica' in response.data # "Práctica" in UTF-8 + + +def test_exam_page(client): + """Test that the exam page loads correctly.""" + response = client.get('/exam') + assert response.status_code == 200 + assert b'Examen Simulado' in response.data + + +def test_api_questions_all(client): + """Test the API endpoint for getting all questions.""" + response = client.get('/api/questions?mode=all') + assert response.status_code == 200 + + data = json.loads(response.data) + assert isinstance(data, list) + assert len(data) > 0 + + # Check structure of first question + if data: + question = data[0] + assert 'id' in question + assert 'question' in question + assert 'options' in question + assert 'correct' in question + assert 'has_image' in question + assert isinstance(question['options'], list) + assert len(question['options']) >= 2 + + +def test_api_questions_range(client): + """Test the API endpoint for getting questions by range.""" + response = client.get('/api/questions?mode=range&start=1&end=5') + assert response.status_code == 200 + + data = json.loads(response.data) + assert isinstance(data, list) + assert len(data) <= 5 + + # Check that question IDs are within range + for question in data: + assert 1 <= question['id'] <= 5 + + +def test_api_questions_random(client): + """Test the API endpoint for getting random questions.""" + response = client.get('/api/questions?mode=random&count=10') + assert response.status_code == 200 + + data = json.loads(response.data) + assert isinstance(data, list) + assert len(data) <= 10 + + +def test_api_questions_invalid_mode(client): + """Test the API endpoint with invalid mode (falls back to all questions).""" + response = client.get('/api/questions?mode=invalid') + assert response.status_code == 200 + + data = json.loads(response.data) + assert isinstance(data, list) + # Should return all questions as fallback + assert len(data) > 0 + + +def test_api_questions_missing_parameters(client): + """Test the API endpoint with missing parameters (uses defaults).""" + # Range mode without start/end (uses defaults) + response = client.get('/api/questions?mode=range') + assert response.status_code == 200 + + data = json.loads(response.data) + assert isinstance(data, list) + assert len(data) > 0 + + # Random mode without count (uses default of 20) + response = client.get('/api/questions?mode=random') + assert response.status_code == 200 + + data = json.loads(response.data) + assert isinstance(data, list) + assert len(data) <= 20 # Should use default count + + +def test_static_files(client): + """Test that static files are accessible.""" + # Test CSS file + response = client.get('/static/css/fontawesome-local.css') + assert response.status_code == 200 + + # Test JS file + response = client.get('/static/js/app.js') + assert response.status_code == 200 + + +def test_favicon(client): + """Test that favicon is accessible.""" + response = client.get('/static/favicon.svg') + assert response.status_code == 200 + + +def test_question_parsing_consistency(client): + """Test that question parsing is consistent across API calls.""" + # Get the same question range twice + response1 = client.get('/api/questions?mode=range&start=1&end=3') + response2 = client.get('/api/questions?mode=range&start=1&end=3') + + assert response1.status_code == 200 + assert response2.status_code == 200 + + data1 = json.loads(response1.data) + data2 = json.loads(response2.data) + + # Should return the same questions + assert len(data1) == len(data2) + for q1, q2 in zip(data1, data2): + assert q1['id'] == q2['id'] + assert q1['question'] == q2['question'] + assert q1['correct'] == q2['correct'] + + +def test_question_structure_validation(client): + """Test that all questions have the required structure.""" + response = client.get('/api/questions?mode=range&start=1&end=10') + assert response.status_code == 200 + + data = json.loads(response.data) + + for question in data: + # Required fields + assert 'id' in question + assert 'question' in question + assert 'options' in question + assert 'correct' in question + assert 'has_image' in question + + # Data types + assert isinstance(question['id'], int) + assert isinstance(question['question'], str) + assert isinstance(question['options'], list) + assert isinstance(question['correct'], str) + assert isinstance(question['has_image'], bool) + + # Content validation + assert len(question['question']) > 0 + assert len(question['options']) >= 2 + assert question['correct'] in ['a', 'b', 'c', 'd'] + + # If has image, should have image URL + if question['has_image']: + assert 'image' in question + assert len(question['image']) > 0 diff --git a/tests/test_clean_parser.py b/tests/test_clean_parser.py new file mode 100644 index 0000000..2f7d145 --- /dev/null +++ b/tests/test_clean_parser.py @@ -0,0 +1,57 @@ +#!/usr/bin/env python3 +import re + +def test_clean_parser(): + # Simular algunas líneas del markdown con ✅ + test_lines = [ + "a) Recoger o dejar pasajeros o carga en cualquier lugar", + "b) Dejar animales sueltos o situarlos de forma tal que obstaculicen solo un poco el tránsito", + "✅ c) Recoger o dejar pasajeros en lugares autorizados.", + "d) Ejercer el comercio ambulatorio o estacionario" + ] + + print("🧪 Probando el parser limpio...") + print("=" * 50) + + options = [] + correct_option = "" + + for line in test_lines: + original_line = line.strip() + print(f"Línea original: '{original_line}'") + + # Verificar si esta línea tiene el ✅ + if '✅' in original_line: + # Extraer la letra de la opción correcta + match = re.search(r'✅\s*([a-d])\)', original_line) + if match: + correct_option = match.group(1) + print(f" ✅ Respuesta correcta encontrada: {correct_option}") + + # Limpiar la línea removiendo el ✅ completamente + clean_line = re.sub(r'✅\s*', '', original_line) + clean_line = re.sub(r'✅', '', clean_line) # Por si hay ✅ sin espacios + clean_line = clean_line.strip() + + print(f" Línea limpia: '{clean_line}'") + print(f" ¿Contiene ✅?: {'✅' in clean_line}") + + options.append(clean_line) + print("-" * 30) + + print(f"\n📊 Resultado final:") + print(f"Respuesta correcta: {correct_option}") + print(f"Opciones limpias:") + for i, option in enumerate(options): + letter = chr(97 + i) # a, b, c, d + marker = "✅" if letter == correct_option else " " + print(f" {marker} {option}") + + # Verificar que no hay ✅ en las opciones + if '✅' in option: + print(f" ❌ ERROR: Todavía hay ✅ en la opción!") + else: + print(f" ✅ OK: Sin ✅ en la opción") + +if __name__ == "__main__": + test_clean_parser() diff --git a/tests/test_parser.py b/tests/test_parser.py new file mode 100644 index 0000000..0a6a036 --- /dev/null +++ b/tests/test_parser.py @@ -0,0 +1,112 @@ +#!/usr/bin/env python3 +import re + +def test_parse_markdown_questions(): + with open('data/balotario_clase_a_cat_I.md', 'r', encoding='utf-8') as file: + content = file.read() + + questions = [] + + # Dividir el contenido por preguntas usando ### como separador + question_blocks = re.split(r'\n### (\d+)\n', content)[1:] # Ignorar el primer elemento vacío + + for i in range(0, len(question_blocks), 2): + if i + 1 >= len(question_blocks): + break + + question_num = int(question_blocks[i]) + question_content = question_blocks[i + 1].strip() + + # Solo procesar las primeras 3 preguntas para prueba + if question_num > 3: + break + + # Verificar si hay imagen al inicio (ahora soporta imágenes locales) + has_image = ('![](https://sierdgtt.mtc.gob.pe/Content/img-data/' in question_content or + '![](/static/images/' in question_content) + image_url = "" + if has_image: + # Intentar primero imágenes locales, luego remotas + img_match = re.search(r'!\[\]\((/static/images/[^)]+)\)', question_content) + if not img_match: + img_match = re.search(r'!\[\]\((https://sierdgtt\.mtc\.gob\.pe/Content/img-data/[^)]+)\)', question_content) + + if img_match: + image_url = img_match.group(1) + question_content = re.sub(r'!\[\]\([^)]+\)\n*', '', question_content).strip() + + # Separar pregunta de opciones + lines = question_content.split('\n') + question_lines = [] + option_lines = [] + in_options = False + + for line in lines: + line = line.strip() + if not line: + continue + if re.match(r'^✅?\s*[a-d]\)', line): + in_options = True + option_lines.append(line) + elif not in_options: + question_lines.append(line) + + question_text = ' '.join(question_lines).strip() + + # Extraer opciones y respuesta correcta + options = [] + correct_option = "" + + for line in option_lines: + original_line = line.strip() + + # Verificar si esta línea tiene el ✅ + if '✅' in original_line: + # Extraer la letra de la opción correcta + match = re.search(r'✅\s*([a-d])\)', original_line) + if match: + correct_option = match.group(1) + + # Limpiar la línea removiendo el ✅ completamente + clean_line = re.sub(r'✅\s*', '', original_line).strip() + options.append(clean_line) + + if len(options) >= 2 and correct_option and question_text: # Validar que tenemos datos completos + questions.append({ + 'id': question_num, + 'question': question_text, + 'options': options, + 'correct': correct_option, + 'image': image_url, + 'has_image': has_image + }) + + # Assertions para validar que el parsing funciona correctamente + assert len(questions) > 0, "No se parsearon preguntas" + assert len(questions) <= 3, "Se parsearon más preguntas de las esperadas" + + for q in questions: + assert 'id' in q, "Falta el ID de la pregunta" + assert 'question' in q, "Falta el texto de la pregunta" + assert 'options' in q, "Faltan las opciones" + assert 'correct' in q, "Falta la respuesta correcta" + assert len(q['options']) >= 2, f"Pregunta {q['id']} tiene menos de 2 opciones" + assert q['correct'] in ['a', 'b', 'c', 'd'], f"Respuesta correcta inválida en pregunta {q['id']}" + assert len(q['question']) > 0, f"Pregunta {q['id']} está vacía" + +# Ejecutar prueba +if __name__ == "__main__": + questions = test_parse_markdown_questions() + + print(f"✅ Se parsearon {len(questions)} preguntas correctamente") + print("=" * 60) + + for q in questions: + print(f"Pregunta {q['id']}: {q['question'][:50]}...") + print(f"Respuesta correcta: {q['correct']}") + print("Opciones:") + for i, option in enumerate(q['options']): + letter = chr(97 + i) # a, b, c, d + marker = "✅" if letter == q['correct'] else " " + print(f" {marker} {option}") + print("-" * 40)