Metadata-Version: 2.4
Name: kariz
Version: 0.1.1
Summary: Kariz — a content management system built on Django and Wagtail
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://pypi.org/project/kariz/
Keywords: cms,django,wagtail,persian,rtl,content-management
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# کاریز | kariz

> [فارسی](#فارسی) · [English](#english)

---
> ⚠ **چرا این صفحه وجود دارد؟**
> نسخه‌ای که روی PyPI ثبت شده، خالی است و فقط نامِ `kariz` را نگه می‌دارد.
> تا زمانی که نقص‌ها برطرف شوند، `pip install kariz` شما را به این سامانه نمی‌رساند.


## فارسی

### کاریز چیست

کاریز یک سامانهٔ مدیریت محتوا است که روی جنگو و وگتیل ساخته شده. با مجوز BSD منتشر شده، ولی چون هنوز نقص‌هایی برطرف نشده، **به‌طور عمومی منتشر نشده است**.


### کاریز برای چه افرادی ساخته شده است

**اگر برنامه‌نویس نباشید و نخواهید با برنامه‌نویسی درگیر شوید:** همین‌جا تفاوت با وگتیل شروع می‌شود. کسی که می‌خواهد سایتش را خودش اداره کند و سال‌ها بعد هم بتواند آن را تغییر دهد.

**اگر توسعه‌دهندهٔ پایتون باشید:** هر چیزی که از جنگو یا وگتیل انتظار دارید اینجا هم هست. هستهٔ کاریز، جنگو و وگتیل است. کاریز روی آن‌ها سوار شده و جایگزینشان نیست. هر پروژه‌ای که با کاریز بسازید، یک پروژهٔ جنگو-وگتیل کامل است: همان ORM، همان پنل، همان middleware، همان تست‌ها. هیچ چیز پنهان یا غیرقابل‌دسترس نیست.

### کاریز چه دارد

#### صفحه‌ساز بر پایهٔ بلاک

مدیریت محتوا بر اساس بلاک طراحی شده است.

بلاک‌ها انواع محتوایی هستند که می‌توانید روی هم بچینید — متن، تصویر، نقل‌قول، جدول، کارت، فرم و موارد دیگر. در اداره، صفحه یک ظرف خالی نیست؛ خودتان آن را می‌سازید.

#### چیدمان (layout)

بلاک‌ها خیلی مفید هستند، ولی به این نتیجه رسیدیم که برای کاربر، **راحتی مهم‌تر از امکانات گسترده است.** اینکه هر بار در هر صفحه بخواهید بلاک‌های تکراری بسازید آزاردهنده است.

برای همین می‌توانید **یک‌بار برای صفحات** چیدمان‌هایی بسازید که از قبل مشخص کند چه چیزهایی در صفحه هست.

هر صفحه یک چیدمان دارد و در چیدمان می‌توانید تعیین کنید صفحه از چه **اسلات‌هایی** ساخته شود — محتوای اصلی، کنارِ صفحه، سربرگ، فهرست، فرادادهٔ مطلب، تصویرِ شاخص — و هنگام ساخت صفحه فقط محتوای اسلات‌ها را پر می‌کنید.

اگر چیدمانی که می‌خواهید نبود، ساختنش یک کارِ برنامه‌نویسی نیست؛ مانند صفحات با بلاک‌ها، یک چیدمان جدید بسازید.

#### چندسایتی

با یک نصب، می‌توانید چند سایت را روی دامنه‌های مختلف با محتوای مستقل مدیریت کنید. هر سایت می‌تواند تم، منو و دادهٔ خودش را در **یک پنل مدیریت واحد** داشته باشد.

#### بسته‌های جانبی

امکان ساخت و نصبِ پکیج‌های جانبی وجود دارد. مدیریت بسته‌ها در کاریز با ابزارهای مرسوم مدیریت بستهٔ پایتون انجام می‌شود.

هر بستهٔ جانبی که نصب می‌کنید می‌تواند بلاک‌های جدیدی برای استفاده در اختیار شما بگذارد.

قالب (theme)، زبان و تقویم و چیزهای دیگر را می‌توانید به‌صورت بستهٔ جانبی توسعه دهید یا نصب کنید. با این حال یک قالب پیش‌فرض و زبان فارسی و انگلیسی در بستهٔ نصب اصلی وجود دارد.


---

## English

> ⚠ **Why does this page exist?**
> The version registered on PyPI is empty; it only holds the `kariz` name. Until the
> defects are resolved, `pip install kariz` will not give you this system. If you are
> after the real core, see the `kariz_cms` repository.


### What Kariz is

Kariz is a content management system built on Django and Wagtail. It is released under the BSD licence, but because some defects are still unresolved it is **not publicly released**.


### Who Kariz is for

**If you are not a programmer and do not want to get involved in programming:** this is
where the difference from Wagtail begins. Someone who wants to run their own site and
still be able to change it years later.

**If you are a Python developer:** everything you expect from Django or Wagtail is here
too. The core of Kariz *is* Django and Wagtail. Kariz is built on top of them and does not
replace them. Any project you build with Kariz is a complete Django/Wagtail project: the
same ORM, the same admin, the same middleware, the same tests. Nothing is hidden or out of
reach.

### What Kariz has

#### A block-based page builder

Content management is designed around blocks.

Blocks are the kinds of content you can stack together — text, image, quote, table, card,
form, and more. In the admin, a page is not an empty container; you build it yourself.

#### Layouts

Blocks are very useful, but we came to the conclusion that for the user, **ease of use
matters more than a wide feature set.** Having to rebuild the same blocks over and over
on every page is tiresome.

So you can define **layouts once for your pages**, which determine in advance what belongs
on the page.

Every page has a layout, and in the layout you decide which **slots** the page is built
from — main content, sidebar, header, listing, post meta, post cover image — and when you
create the page you only fill in the content of those slots.

If the layout you want does not exist, making one is not a programming task; just as with
block-built pages, build a new layout.

#### Multi-site

With a single installation you can manage several sites on different domains, each with
independent content. Each site can have its own theme, menus and data inside **a single
admin panel**.

#### Third-party packages

Building and installing third-party packages is supported. Package management in Kariz
uses the standard Python packaging tools.

Any third-party package you install can make new blocks available to you.

Themes, languages, calendars and the like can be developed or installed as a third-party
package. That said, a default theme and the Persian and English languages ship in the main
installed package.

