Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ jobs:
with:
python-version: "3.12"

- name: Install MkDocs Material
run: pip install mkdocs-material
- name: Install Zensical
run: pip install zensical

- uses: actions/configure-pages@v4

- name: Build docs
run: mkdocs build --strict
run: zensical build --strict

- uses: actions/upload-pages-artifact@v3
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
before-script-linux: |
# cmake + perl-IPC-Cmd are required by openssl-sys (vendored build)
if command -v yum &>/dev/null; then
yum install -y cmake perl-IPC-Cmd
yum install -y cmake perl-IPC-Cmd perl-Time-Piece
fi

- uses: actions/upload-artifact@v4
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Pascal handles workspace scaffolding, dependency wiring, and UV workspace sync

**[Documentation](https://sandeep-selvaraj.github.io/pascal)** · [Installation](https://sandeep-selvaraj.github.io/pascal/installation/) · [Quickstart](https://sandeep-selvaraj.github.io/pascal/quickstart/) · [Commands](https://sandeep-selvaraj.github.io/pascal/commands/)

> Heavily inspired by [Polylith](https://polylith.gitbook.io/polylith) — *packages* map to Polylith's components, *apps* to its bases, brought to the Python/UV ecosystem with a minimal footprint.

---

## Installation
Expand Down Expand Up @@ -182,8 +184,8 @@ pascal --version
### Serve docs locally

```bash
pip install mkdocs-material
mkdocs serve
pip install zensical
zensical serve
```
---

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,8 @@ pascal --version
## Serving docs locally

```bash
pip install mkdocs-material
mkdocs serve
pip install zensical
zensical serve
# open http://127.0.0.1:8000
```

Expand Down
10 changes: 10 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@ pascal test
| **app** | A deployable entry-point under `apps/`. Has a `[project.scripts]` entry and may depend on workspace packages. |
| **brick** | Internal term for any workspace member (package or app). |

## Inspiration

Pascal is heavily inspired by [Polylith](https://polylith.gitbook.io/polylith) — an architecture concept that encourages decomposing a system into small, focused, reusable *components* and *bases*, all living in a single repository.

Polylith's core idea is that code should be organised around **what it does** (components) rather than **which service it belongs to** — making it easy to compose different combinations of components into deployable artifacts. Pascal brings this same philosophy to the Python ecosystem with a simpler surface area: *packages* map to Polylith's components, and *apps* map to its bases.

Where Polylith is an opinionated full-stack architecture, pascal is deliberately minimal — it handles the scaffolding and dependency wiring and then gets out of the way, leaving the rest to UV and standard Python tooling.

If you find the ideas here compelling, the [Polylith documentation](https://polylith.gitbook.io/polylith) and its [Python tooling](https://davidvujic.github.io/python-polylith-docs/) are well worth reading.

## Next steps

- [Install pascal](installation.md)
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ markdown_extensions:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- attr_list
- md_in_html
- def_list
- tables
- toc:
Expand Down