youca-setup 0.1.0__tar.gz

youca_setup-0.1.0/.gitignore

@@ -0,0 +1,70 @@
+# 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/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+
+# Pytest / coverage
+.pytest_cache/
+.coverage
+.coverage.*
+.hypothesis/
+htmlcov/
+
+# Ruff / mypy caches
+.ruff_cache/
+.mypy_cache/
+
+# IDE
+.idea/
+.vscode/
+
+# OS
+.DS_Store
+
+# Secrets and local configuration
+.env
+.env.*
+!.env.example
+
+# Internal specification (not distributed)
+cahier-des-charges-youca-setup.md
+
+# Youca Setup generated artifacts
+backups/
+filestore/
+*.log
+data/
+
+# mkdocs / docs build
+site/

youca_setup-0.1.0/CHANGELOG.md

@@ -0,0 +1,168 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+
+- Renamed the distribution, package and CLI to **youca-setup**. The project
+  config file is now `youca-setup.yaml` and the registry lives in
+  `~/.youca-setup/projects`. Earlier PyPI releases are deprecated in favour of
+  `youca-setup` (see README).
+
+### Added
+
+- Project skeleton: `src/` layout, Hatchling packaging, CLI entry point.
+- CLI commands (stubs): `init`, `start`, `stop`, `restart`, `status`, `logs`,
+  `doctor`, `module`, `backup`, `restore`.
+- Internal packages: `docker/`, `postgres/`, `project/`, `diagnostics/`,
+  `utils/` with typed stubs and `TODO`s.
+- Test suite skeleton with smoke tests and mocked Docker/psycopg fixtures.
+- Tooling: Ruff (lint + format), mypy (strict), pre-commit hooks, GitHub
+  Actions CI and PyPI release workflow.
+- `utils/ports.py`: real implementation of `is_port_free`, `find_free_port`
+  and `_probe` via TCP socket binding, with unit tests for the occupied /
+  free / exhausted cases.
+- `docker/compose.py`: real `http_port()` / `set_http_port()` (read host port
+  bound to Odoo, persist a new one) with unit tests, including the missing
+  service / missing ports failure paths.
+- `project/generator.py`: real `generate()` scaffolding the full project
+  layout (`youca-setup.yaml`, `.env`, `.gitignore`, `README.md`,
+  `docker-compose.yml`, `config/odoo.conf`, addons/data/backups directories).
+  New `.gitignore.j2` and `README.md.j2` templates; fixed the stray HTML
+  comment in `env.j2`. Unit tests cover structure, existing-directory guard,
+  clean `.env` and HTTP port rendering.
+- `commands/init.py`: full implementation of the interactive and non-interactive
+  project creation flow — name/version/backend validation, Docker detection
+  with warning, automatic HTTP port alternative when occupied, and a Rich
+  recap panel. Five unit tests cover structure creation, name rejection, no-
+  Docker warning, port fallback, and the interactive survey via mocked prompts.
+- `docker/manager.py`: real orchestration via the ``docker compose`` CLI —
+  `compose()`, `start()` (with `--wait` fallback), `stop()`, `restart()`,
+  `logs()` (captured or streamed) and `compose_available()`. Eight new unit
+  tests cover command construction, failure handling, missing CLI, log
+  capture and streaming.
+- Commands ``start/stop/restart/status/logs``: full implementations backed
+  by the new `DockerManager`, with a shared port-conflict resolver
+  (`_port_utils.py`) and a `project/loader.py` helper that loads the
+  project from the working directory. Thirteen unit tests (including the
+  "outside project" exit guard) cover all five commands.
+- `postgres/manager.py`: real administration of the PostgreSQL database —
+  `ping()` (connectivity + credential check), `list_databases()`,
+  `create_database()` (no-op when it exists), `dump()` and `restore()` via
+  `pg_dump`/`pg_restore` (`--no-owner`, custom format), with the password
+  carried exclusively through the environment. `run_command` now accepts an
+  `env` override. Seven unit tests cover success/failure paths, identifier
+  quoting and the drop/recreate sequence.
+- `diagnostics/`: seven health checks (python, docker, docker-compose,
+  postgres, ports, config, network) in `checks.py`, plus a fixer that maps
+  failures to corrective actions — destructive ones always confirmed via
+  Rich. `doctor` now renders the checks as a table, supports `--check` and
+  applies fixes with `--fix`. Twenty-four new unit tests cover each check's
+  pass/fail paths, outside-a-project behaviour, fix confirmation/skip logic
+  and the port-reassignment fix.
+- `project/odoo_module.py`: full module scaffold generator producing
+  `__manifest__.py`, and, when ``--model`` is given, `models/` (model class),
+  `views/` (action window + list/form views), `security/` (access CSV) and
+  `tests/` (TransactionCase skeleton) — all via Jinja2 templates.
+  ``validate_identifier`` enforces snake_case, ``--force`` allows
+  regeneration. Nine generator tests and four command tests cover full
+  structure, model naming, force overwrite and invalid-name rejection.
+- `project/backup.py`: timestamped archive creation (database dump in
+  custom format, filestore via an ``alpine`` Docker helper, ``config/`` and
+  ``youca-setup.yaml``) and restore (strict archive validation, mandatory
+  confirmation, container stop/restore/start). The filestore copy silently
+  skips when Docker or the volume is unavailable. Seven manager tests and
+  seven command tests cover archive structure, invalid archive rejection,
+  confirmation flow, and end-to-end restore.
+- `commands/info.py` and `commands/projects.py`: multi-project support —
+  ``youca-setup info`` prints the current project's configuration and container
+  state; ``youca-setup projects`` scans a directory (default
+  ``~/.youca-setup/projects``) and renders a summary table, skipping directories
+  with an invalid ``youca-setup.yaml``. Six new unit tests cover both commands,
+  the missing-directory hint and broken-config handling.
+- Fix: single-command modules were registered as nested Typer groups, so the
+  CLI produced doubled commands (``youca-setup init init demo``). They now register
+  their command functions directly on the top-level app; only ``module`` keeps
+  its nested ``create`` subcommand. New ``tests/test_cli.py`` guards the
+  top-level wiring (5 tests) and a complete build + clean-venv smoke test was
+  run against the ``init/info/projects/module/status`` flow.
+- Finitions: comprehensive ``docs/index.md`` (user + developer guides),
+  README feature list extended with ``info``/``projects``, real integration
+  tests marked ``integration`` (skipped when Docker is unavailable) that
+  validate the generated Compose file with ``docker compose config`` and the
+  port probes against a live container (4 tests), plus packaging validation
+  (build + clean-venv install smoke test).
+- Project registry: ``youca-setup init`` now registers every project in
+  ``~/.youca-setup/projects`` so ``youca-setup projects`` lists it out of the box. New
+  ``youca-setup remove`` command unregisters a project (``--delete`` removes the
+  directory after confirmation). ``ProjectConfig`` gained an optional ``path``
+  field and ``youca-setup projects`` displays the project location. Eleven new
+  tests cover registration, listing, broken entries and the remove flow.
+- Secrets: ``youca-setup init`` generates random ``POSTGRES_PASSWORD`` and
+  ``ADMIN_PASSWORD`` values instead of shipping the hard-coded defaults, and
+  ``odoo.conf`` now wires ``admin_passwd`` from the generated ``.env``. New
+  tests assert the values are random and that the two files stay in sync.
+- CI: the matrix job is now joined by a dedicated integration job that runs
+  ``pytest -m integration`` on the GitHub-hosted Docker daemon.
+- Fix: backup restore now extracts archives with Python 3.12+ ``filter="data"``
+  (with a fallback for older interpreters), removing the Python 3.14
+  ``DeprecationWarning`` that previously appeared in the test output.
+- Shell: new ``youca-setup shell`` command opens an interactive session inside a
+  running container — ``/bin/bash`` for the ``odoo`` service, ``psql`` with the
+  credentials from ``.env`` for ``db``, and ``--command`` for a custom
+  invocation. ``DockerManager.shell()`` wires it to ``docker compose exec``.
+- Reusable templates: ``youca-setup init --template <dir>`` now renders the project
+  from a custom Jinja2 template directory; templates missing there fall back to
+  the bundled set (``ChoiceLoader``), so a single customized ``env.j2`` is
+  enough to brand the scaffold.
+- Git integration: ``youca-setup init`` runs ``git init`` (``--initial-branch=main``,
+  with a plain ``git init`` fallback) inside the new project, honouring the
+  generated ``.gitignore``. ``--no-git`` skips it.
+- Export/import: new ``youca-setup export`` and ``youca-setup import`` commands create
+  and restore a portable environment snapshot (``youca-setup.yaml``, ``.env``,
+  ``docker-compose.yml``, ``config/``, addons, README and gitignore — no
+  database, filestore or backups). ``import`` validates the archive, refuses to
+  overwrite existing directories and registers the project automatically.
+- Windows support: database dump/restore no longer needs local
+  ``pg_dump``/``pg_restore``/``psql`` binaries — both run inside the database
+  container via ``docker compose exec``/``cp``, dropping and recreating the
+  database (``psql``/``pg_restore`` connected as the ``.env`` ``POSTGRES_USER``
+  through the unix socket).
+- Fix: the filestore copy inside ``backup``/``restore`` now streams a tar
+  archive over the ``docker run`` stdin/stdout pipe instead of using a host
+  bind mount, so the staging files stay owned by the host user (a bind-mounted
+  copy is written as the container user and becomes unreadable on
+  user-namespace remapped daemons) and no path normalization is needed.
+- Fix: the filestore copy inside ``backup``/``restore`` now raises a clear
+  error when the Docker volume is unavailable, instead of silently producing an
+  archive without filestore content.
+- Fix: archive extraction shares a single safe helper
+  (``utils.tar.safe_extract``) that blocks path-traversal members and applies
+  the Python 3.12+ ``filter="data"`` mode, used by both backup restore and
+  environment import.
+- Version management: the supported Odoo and PostgreSQL majors now live in a
+  single source of truth (``ProjectConfig``) and are validated both at init and
+  when loading any ``youca-setup.yaml`` — an unknown version fails loudly instead of
+  producing a broken environment. ``youca-setup init`` gained ``--postgres-version``
+  (flag and interactive prompt), completing the existing ``--odoo-version``;
+  defaults track the latest stable at each release (Odoo 19, PostgreSQL 18).
+- Fix: the generated project no longer pre-seeds an empty ``POSTGRES_DB``
+  database. Combined with ``dbfilter`` it made Odoo bind to an uninitialized
+  database and crash (``KeyError: 'ir.http'``, HTTP 500) instead of offering
+  the database manager. The database is now created through the Odoo web UI
+  (``/web/database/manager``, master password ``ADMIN_PASSWORD``), the
+  standard Docker image workflow; ``youca-setup start`` prints the hint.
+- Fix: PostgreSQL 18 refuses to start with the ``/var/lib/postgresql/data``
+  mount used by older majors (it moved its data directory into a subfolder for
+  ``pg_upgrade`` support). The generated Compose file now mounts the volume on
+  ``/var/lib/postgresql`` for PostgreSQL 18 and keeps the historical mount on
+  older majors. With this fix every supported combination (Odoo 17/18/19,
+  PostgreSQL 16/17/18) was validated end to end with real containers.
+- CI: the test matrix now covers Python 3.10 through 3.14, guaranteeing the
+  runtime works on the latest interpreters.

youca_setup-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Youca Setup contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

youca_setup-0.1.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.5
+Name: youca-setup
+Version: 0.1.0
+Summary: Youca Setup for Odoo - CLI tool to create, configure and manage Odoo development environments (Docker + PostgreSQL).
+Project-URL: Homepage, https://github.com/Fitiafenohaja/youca-setup
+Project-URL: Repository, https://github.com/Fitiafenohaja/youca-setup
+Project-URL: Documentation, https://github.com/Fitiafenohaja/youca-setup#readme
+Project-URL: Changelog, https://github.com/Fitiafenohaja/youca-setup/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/Fitiafenohaja/youca-setup/issues
+Author: Youca Setup contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,development,docker,environment,odoo,postgresql
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: docker>=7.0
+Requires-Dist: jinja2>=3.1
+Requires-Dist: psutil>=5.9
+Requires-Dist: psycopg[binary]>=3.1
+Requires-Dist: pydantic>=2.6
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.7
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: mypy>=1.9; extra == 'dev'
+Requires-Dist: pre-commit>=3.6; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1; extra == 'dev'
+Requires-Dist: pytest-mock>=3.12; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: testcontainers>=4.0; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Youca Setup for Odoo
+
+[![CI](https://github.com/Fitiafenohaja/youca-setup/actions/workflows/ci.yml/badge.svg)](https://github.com/Fitiafenohaja/youca-setup/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/youca-setup.svg)](https://pypi.org/project/youca-setup/)
+[![Python versions](https://img.shields.io/pypi/pyversions/youca-setup.svg)](https://pypi.org/project/youca-setup/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Youca Setup for Odoo is a command-line tool that creates, configures and manages
+**Odoo development environments** backed by Docker and PostgreSQL. It turns a
+blank machine into a working Odoo project in one command.
+
+## Features
+
+- `youca-setup init` — scaffold a full Odoo project (Compose file, `odoo.conf`, `.env`, addons directories); `--odoo-version`/`--postgres-version` pick the image majors (defaults: latest supported); `--template` reuses a custom template directory and a git repository is initialised by default
+- `youca-setup start` / `stop` / `restart` — environment lifecycle via Docker Compose
+- `youca-setup status` — running state, ports and health at a glance
+- `youca-setup logs` — container logs without touching Docker directly
+- `youca-setup shell` — interactive shell (`/bin/bash` or `psql`) inside a container
+- `youca-setup doctor` — diagnose Docker, PostgreSQL, ports and configuration; `--fix` applies corrections
+- `youca-setup module create` — scaffold Odoo addon modules with an optional base model
+- `youca-setup backup` / `restore` — database + filestore + configuration archives
+- `youca-setup export` / `import` — portable environment snapshots (config + `.env` + addons)
+- `youca-setup info` / `projects` / `remove` — inspect, list or unregister known projects
+
+## Installation
+
+Requires Python 3.10+ and Docker with Compose v2.
+
+```bash
+pip install youca-setup
+```
+
+## Quick start
+
+```bash
+# Create a project (Odoo 18, PostgreSQL 16, a custom addons directory)
+youca-setup init school --odoo-version 18 --postgres-version 16 --postgres docker --addons custom-addons
+
+# Run the environment
+cd school
+youca-setup start        # http://localhost:8069
+
+# Scaffold a module with a base model
+youca-setup module create school_management --model student
+
+# Check that everything is healthy
+youca-setup doctor
+```
+
+## Commands
+
+| Command | Purpose |
+|---|---|
+| `youca-setup init` | Create a new Odoo project (interactive or scripted) |
+| `youca-setup start` | Start the environment via Docker Compose |
+| `youca-setup stop` | Stop the environment |
+| `youca-setup restart` | Restart the environment |
+| `youca-setup status` | Show service state and host ports |
+| `youca-setup logs` | Show service logs |
+| `youca-setup info` | Show details of the current project |
+| `youca-setup projects` | List all known projects |
+| `youca-setup remove` | Unregister (and optionally delete) a project |
+| `youca-setup doctor` | Diagnose and (optionally) fix the environment |
+| `youca-setup module create` | Scaffold an Odoo addon module |
+| `youca-setup backup` | Create a database + filestore + config archive |
+| `youca-setup restore` | Restore from a backup archive |
+| `youca-setup shell` | Open an interactive shell in a container |
+| `youca-setup export` | Export the environment to a portable `.tar.gz` |
+| `youca-setup import` | Import an environment archive into a new project |
+
+## Documentation
+
+Full guides (user and developer) are available in
+[docs/](docs/index.md). Release notes are tracked in
+[CHANGELOG.md](CHANGELOG.md).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pre-commit install
+ruff check .
+mypy src/youca_setup
+pytest
+```
+
+## License
+
+Distributed under the [MIT License](LICENSE).

youca_setup-0.1.0/README.md

@@ -0,0 +1,89 @@
+# Youca Setup for Odoo
+
+[![CI](https://github.com/Fitiafenohaja/youca-setup/actions/workflows/ci.yml/badge.svg)](https://github.com/Fitiafenohaja/youca-setup/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/youca-setup.svg)](https://pypi.org/project/youca-setup/)
+[![Python versions](https://img.shields.io/pypi/pyversions/youca-setup.svg)](https://pypi.org/project/youca-setup/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Youca Setup for Odoo is a command-line tool that creates, configures and manages
+**Odoo development environments** backed by Docker and PostgreSQL. It turns a
+blank machine into a working Odoo project in one command.
+
+## Features
+
+- `youca-setup init` — scaffold a full Odoo project (Compose file, `odoo.conf`, `.env`, addons directories); `--odoo-version`/`--postgres-version` pick the image majors (defaults: latest supported); `--template` reuses a custom template directory and a git repository is initialised by default
+- `youca-setup start` / `stop` / `restart` — environment lifecycle via Docker Compose
+- `youca-setup status` — running state, ports and health at a glance
+- `youca-setup logs` — container logs without touching Docker directly
+- `youca-setup shell` — interactive shell (`/bin/bash` or `psql`) inside a container
+- `youca-setup doctor` — diagnose Docker, PostgreSQL, ports and configuration; `--fix` applies corrections
+- `youca-setup module create` — scaffold Odoo addon modules with an optional base model
+- `youca-setup backup` / `restore` — database + filestore + configuration archives
+- `youca-setup export` / `import` — portable environment snapshots (config + `.env` + addons)
+- `youca-setup info` / `projects` / `remove` — inspect, list or unregister known projects
+
+## Installation
+
+Requires Python 3.10+ and Docker with Compose v2.
+
+```bash
+pip install youca-setup
+```
+
+## Quick start
+
+```bash
+# Create a project (Odoo 18, PostgreSQL 16, a custom addons directory)
+youca-setup init school --odoo-version 18 --postgres-version 16 --postgres docker --addons custom-addons
+
+# Run the environment
+cd school
+youca-setup start        # http://localhost:8069
+
+# Scaffold a module with a base model
+youca-setup module create school_management --model student
+
+# Check that everything is healthy
+youca-setup doctor
+```
+
+## Commands
+
+| Command | Purpose |
+|---|---|
+| `youca-setup init` | Create a new Odoo project (interactive or scripted) |
+| `youca-setup start` | Start the environment via Docker Compose |
+| `youca-setup stop` | Stop the environment |
+| `youca-setup restart` | Restart the environment |
+| `youca-setup status` | Show service state and host ports |
+| `youca-setup logs` | Show service logs |
+| `youca-setup info` | Show details of the current project |
+| `youca-setup projects` | List all known projects |
+| `youca-setup remove` | Unregister (and optionally delete) a project |
+| `youca-setup doctor` | Diagnose and (optionally) fix the environment |
+| `youca-setup module create` | Scaffold an Odoo addon module |
+| `youca-setup backup` | Create a database + filestore + config archive |
+| `youca-setup restore` | Restore from a backup archive |
+| `youca-setup shell` | Open an interactive shell in a container |
+| `youca-setup export` | Export the environment to a portable `.tar.gz` |
+| `youca-setup import` | Import an environment archive into a new project |
+
+## Documentation
+
+Full guides (user and developer) are available in
+[docs/](docs/index.md). Release notes are tracked in
+[CHANGELOG.md](CHANGELOG.md).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pre-commit install
+ruff check .
+mypy src/youca_setup
+pytest
+```
+
+## License
+
+Distributed under the [MIT License](LICENSE).