richie 3.1.3.dev35__tar.gz → 3.1.3.dev37__tar.gz

richie-3.1.3.dev37/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: richie
+Version: 3.1.3.dev37
+Summary: A CMS to build learning portals for open education
+Author-email: "Open FUN (France Université Numérique)" <fun.dev@fun-mooc.fr>
+License: MIT License
+        
+        Copyright (c) 2018-present GIP FUN MOOC.
+        
+        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.
+        
+        
+Project-URL: Bug Tracker, https://github.com/openfun/richie/issues/new
+Project-URL: Changelog, https://github.com/openfun/richie/blob/master/CHANGELOG.md
+Project-URL: Homepage, https://github.com/openfun/richie
+Project-URL: Repository, https://github.com/openfun/richie
+Project-URL: Documentation, https://richie.education/
+Project-URL: Demonstration website, https://demo.richie.education/
+Keywords: Django,Django-CMS,Open edX
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: arrow<2
+Requires-Dist: babel<3
+Requires-Dist: Django<5
+Requires-Dist: djangocms-file<4
+Requires-Dist: djangocms-googlemap<3
+Requires-Dist: djangocms-link<6,>=5.0.0
+Requires-Dist: djangocms-picture<5
+Requires-Dist: djangocms-text-ckeditor<6
+Requires-Dist: djangocms-video<4
+Requires-Dist: djangorestframework<4
+Requires-Dist: django-autocomplete-light<4
+Requires-Dist: django-cms<4.0.0,>=3.11.0
+Requires-Dist: django-parler<3,>=2.3
+Requires-Dist: django-redis<6,>=4.11.0
+Requires-Dist: django-treebeard<5
+Requires-Dist: dj-pagination<3
+Requires-Dist: easy_thumbnails[svg]<2.10,>=2.8
+Requires-Dist: elasticsearch<7.0.0,>=6.0.0
+Requires-Dist: exrex<1
+Requires-Dist: importlib-metadata<9
+Requires-Dist: oauthlib<4,>=3.2.2
+Requires-Dist: requests<3,>=2.32.3
+Provides-Extra: dev
+Requires-Dist: bandit==1.8.3; extra == "dev"
+Requires-Dist: beaupy==3.10.1; extra == "dev"
+Requires-Dist: black==25.1.0; extra == "dev"
+Requires-Dist: pyRdfa3==3.6.4; extra == "dev"
+Requires-Dist: cssselect==1.3.0; extra == "dev"
+Requires-Dist: factory-boy==3.3.3; extra == "dev"
+Requires-Dist: flake8==7.2.0; extra == "dev"
+Requires-Dist: flake8-pyproject==1.2.3; extra == "dev"
+Requires-Dist: htmlmin==0.1.12; extra == "dev"
+Requires-Dist: ipdb==0.13.13; extra == "dev"
+Requires-Dist: ipython==9.0.2; extra == "dev"
+Requires-Dist: isort==6.0.1; extra == "dev"
+Requires-Dist: lxml==5.3.1; extra == "dev"
+Requires-Dist: msgpack==1.1.0; extra == "dev"
+Requires-Dist: mysqlclient==2.2.7; extra == "dev"
+Requires-Dist: pylint==3.3.6; extra == "dev"
+Requires-Dist: pylint-django==2.6.1; extra == "dev"
+Requires-Dist: pytest==8.3.5; extra == "dev"
+Requires-Dist: pytest-cov==6.0.0; extra == "dev"
+Requires-Dist: pytest-django==4.10.0; extra == "dev"
+Requires-Dist: responses==0.25.7; extra == "dev"
+Provides-Extra: ci
+Requires-Dist: twine==6.1.0; extra == "ci"
+Provides-Extra: sandbox
+Requires-Dist: boto3<1.36; extra == "sandbox"
+Requires-Dist: django-storages==1.14.5; extra == "sandbox"
+Requires-Dist: django-configurations==2.5.1; extra == "sandbox"
+Requires-Dist: dockerflow==2024.4.2; extra == "sandbox"
+Requires-Dist: factory-boy==3.3.3; extra == "sandbox"
+Requires-Dist: gunicorn==23.0.0; extra == "sandbox"
+Requires-Dist: psycopg2-binary==2.9.10; extra == "sandbox"
+Requires-Dist: sentry-sdk==2.24.1; extra == "sandbox"
+Dynamic: license-file
+
+# Richie, the best OpenSource CMS to build education portals
+
+[![CircleCI](https://circleci.com/gh/openfun/richie/tree/master.svg?style=svg)](https://circleci.com/gh/openfun/richie/tree/master)
+
+## Overview
+
+`Learning Management Systems` (LMS) are great tools for hosting and playing interactive online
+courses and MOOCs.
+
+However, if you need to build a complete website with flexible content to aggregate your courses,
+in several languages and from different sources, **you will soon need a CMS**.
+
+At "France Université Numérique", we wanted to build an OpenSource portal with `Python` and
+`Django`. That's why we built `Richie` on top of [DjangoCMS](https://www.django-cms.org), one of
+the best CMS on the market, as a toolbox to easily create full fledged websites with a catalog of
+online courses.
+
+Among the features that `Richie` offers out of the box:
+
+- multi-lingual by default,
+- advanced access rights and moderation,
+- catalog of courses synchronized with one or more `LMS` instances,
+- search engine based on `Elasticsearch` and pre-configured to offer full-text queries,
+  multi-facetting, auto-complete,...
+- flexible custom pages for courses, organizations, categories, teachers, blog posts,
+  programs (and their inter-relations),
+- Extensible with any third-party `DjangoCMS` plugin or any third-party `Django` application.
+
+## Discover Richie
+
+If you're looking for a quick preview of `Richie`, you can take a look and have a tour of
+`Richie` on our dedicated [demo site](https://demo.richie.education).
+
+It is connected back-to-back with a demo of OpenEdX running on
+[OpenEdX Docker](https://github.com/openfun/openedx-docker).
+
+Two users are available for testing:
+
+- admin: `admin@example.com`/`admin`
+- student: `edx@example.com`/`edx`
+
+The database is regularly flushed.
+
+## Getting started
+
+Take a look at our [documentation](https://richie.education/docs/discover) to get started with Richie.
+
+## Contributing
+
+### [Contributing guide](https://richie.education/docs/contributing-guide)
+
+Read our [contributing guide](https://richie.education/docs/contributing-guide) to learn about our development process and get started developing on `Richie`.
+
+### License
+
+This work is released under the MIT License (see [LICENSE](./LICENSE)).

richie-3.1.3.dev37/pyproject.toml

@@ -0,0 +1,144 @@
+#
+# Richie package
+#
+[build-system]
+requires = ["setuptools>=60", "setuptools-scm>=8.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "richie"
+dynamic = ["version"]
+description = "A CMS to build learning portals for open education"
+readme = "README.md"
+authors = [{ "name" = "Open FUN (France Université Numérique)", "email" = "fun.dev@fun-mooc.fr" }]
+license = { file = "LICENSE" }
+keywords = ["Django", "Django-CMS", "Open edX"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Django",
+    "Framework :: Django :: 4",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "arrow<2",
+    "babel<3",
+    "Django<5",
+    "djangocms-file<4",
+    "djangocms-googlemap<3",
+    "djangocms-link>=5.0.0,<6",
+    "djangocms-picture<5",
+    "djangocms-text-ckeditor<6",
+    "djangocms-video<4",
+    "djangorestframework<4",
+    "django-autocomplete-light<4",
+    "django-cms>=3.11.0,<4.0.0",
+    "django-parler>=2.3,<3",
+    "django-redis>=4.11.0,<6",
+    "django-treebeard<5",
+    "dj-pagination<3",
+    "easy_thumbnails[svg]>=2.8,<2.10",
+    "elasticsearch>=6.0.0,<7.0.0",
+    "exrex<1",
+    "importlib-metadata<9",
+    "oauthlib>=3.2.2,<4",
+    "requests>=2.32.3,<3",
+]
+
+[project.urls]
+"Bug Tracker" = "https://github.com/openfun/richie/issues/new"
+"Changelog" = "https://github.com/openfun/richie/blob/master/CHANGELOG.md"
+"Homepage" = "https://github.com/openfun/richie"
+"Repository" = "https://github.com/openfun/richie"
+"Documentation" = "https://richie.education/"
+"Demonstration website" = "https://demo.richie.education/"
+
+[tool.setuptools]
+packages = { find = { where = ["src"], exclude = ["tests"] } }
+zip-safe = true
+
+[tool.distutils.bdist_wheel]
+universal = true
+
+[project.optional-dependencies]
+dev = [
+    "bandit==1.8.3",
+    "beaupy==3.10.1",
+    "black==25.1.0",
+    "pyRdfa3==3.6.4",
+    "cssselect==1.3.0",
+    "factory-boy==3.3.3",
+    "flake8==7.2.0",
+    "flake8-pyproject==1.2.3",
+    "htmlmin==0.1.12",
+    "ipdb==0.13.13",
+    "ipython==9.0.2",
+    "isort==6.0.1",
+    "lxml==5.3.1",
+    "msgpack==1.1.0",
+    "mysqlclient==2.2.7",
+    "pylint==3.3.6",
+    "pylint-django==2.6.1",
+    "pytest==8.3.5",
+    "pytest-cov==6.0.0",
+    "pytest-django==4.10.0",
+    "responses==0.25.7",
+]
+ci = [
+    "twine==6.1.0",
+]
+sandbox = [
+    "boto3<1.36",
+    "django-storages==1.14.5",
+    "django-configurations==2.5.1",
+    "dockerflow==2024.4.2",
+    "factory-boy==3.3.3",
+    "gunicorn==23.0.0",
+    "psycopg2-binary==2.9.10",
+    "sentry-sdk==2.24.1",
+]
+
+[tool.flake8]
+max-line-length = 99
+exclude = [
+    ".git",
+    ".venv",
+    "build",
+    "venv",
+    "__pycache__",
+    "node_modules",
+    "*/migrations/*",
+]
+
+[tool.isort]
+profile = "black"
+known_django = "django"
+known_richie = "richie"
+include_trailing_comma = true
+line_length = 88
+multi_line_output = 3
+sections = ["FUTURE","STDLIB","DJANGO","THIRDPARTY","RICHIE","FIRSTPARTY","LOCALFOLDER"]
+skip_glob = "src/frontend/node_modules/**/*,venv"
+
+[tool.pytest.ini_options]
+addopts = "-v --cov-report term-missing"
+python_files = [
+    "test_*.py",
+    "tests.py"
+]
+testpaths = [
+    "tests",
+]
+filterwarnings = [
+    "ignore:::(?!(tests|richie))",
+]
+
+[tool.setuptools_scm]
+local_scheme = "no-local-version"

richie-3.1.3.dev37/src/frontend/js/widgets/SyllabusCourseRunsList/components/CourseProductItem/index.tsx

@@ -0,0 +1,330 @@
+import { Children, useEffect, useMemo } from 'react';
+import { defineMessages, FormattedMessage, FormattedNumber, useIntl } from 'react-intl';
+import c from 'classnames';
+import { Offering, CredentialOrder, Product, ProductType } from 'types/Joanie';
+import { useCourseProduct } from 'hooks/useCourseProducts';
+import { Spinner } from 'components/Spinner';
+import { Icon, IconTypeEnum } from 'components/Icon';
+import { Maybe } from 'types/utils';
+import useDateFormat from 'hooks/useDateFormat';
+import { ProductHelper } from 'utils/ProductHelper';
+import useProductOrder from 'hooks/useProductOrder';
+import { OrderHelper } from 'utils/OrderHelper';
+import { handle } from 'utils/errors/handle';
+import { PacedCourse } from 'types';
+import CertificateItem from './components/CourseProductCertificateItem';
+import CourseRunItem from './components/CourseRunItem';
+import CourseProductItemFooter from './CourseProductItemFooter';
+
+const messages = defineMessages({
+  purchased: {
+    defaultMessage: 'Purchased',
+    description: 'Message displayed when authenticated user owned the product',
+    id: 'components.CourseProductItem.purchased',
+  },
+  loading: {
+    defaultMessage: 'Loading product information...',
+    description:
+      'Accessible text for the initial loading spinner displayed when product is fetching',
+    id: 'components.CourseProductItem.loadingInitial',
+  },
+  fromTo: {
+    defaultMessage: 'From {from} {to, select, undefined {} other {to {to}}}',
+    description: 'Course run date range',
+    id: 'components.CourseProductItem.fromTo',
+  },
+  availableIn: {
+    defaultMessage: 'Available in {languages}',
+    description: 'Course run languages',
+    id: 'components.CourseProductItem.availableIn',
+  },
+  original_price: {
+    defaultMessage: 'Original price:',
+    description: 'Label for the original price of a product',
+    id: 'components.CourseProductItem.original_price',
+  },
+  discounted_price: {
+    defaultMessage: 'Discounted price:',
+    description: 'Label for the discounted price of a product',
+    id: 'components.CourseProductItem.discounted_price',
+  },
+  discount_rate: {
+    defaultMessage: '-{rate}%',
+    description: 'Discount rate information',
+    id: 'components.CourseProductItem.discount_rate',
+  },
+  from: {
+    defaultMessage: 'from {from}',
+    description: 'Discount start date information',
+    id: 'components.CourseProductItem.from',
+  },
+  to: {
+    defaultMessage: 'to {to}',
+    description: 'Discount end date information',
+    id: 'components.CourseProductItem.to',
+  },
+});
+
+export interface CourseProductItemProps {
+  compact?: boolean;
+  course: PacedCourse;
+  productId: Product['id'];
+}
+
+type HeaderProps = {
+  compact: boolean;
+  hasPurchased: boolean;
+  canPurchase: boolean;
+  order: Maybe<CredentialOrder>;
+  product: Product;
+  offering: Offering;
+};
+const Header = ({ product, order, offering, hasPurchased, canPurchase, compact }: HeaderProps) => {
+  const intl = useIntl();
+  const formatDate = useDateFormat();
+
+  // compact mode is available for product until they got an active order.
+  const canShowMetadata = useMemo(() => {
+    return compact && (!order || canPurchase);
+  }, [compact, hasPurchased, canPurchase]);
+
+  const [minDate, maxDate] = useMemo(() => {
+    if (!canShowMetadata) return [undefined, undefined];
+    return ProductHelper.getDateRange(product);
+  }, [canShowMetadata, product]);
+
+  const languages = useMemo(() => {
+    if (!canShowMetadata) return '';
+    return ProductHelper.getLanguages(product, true, intl);
+  }, [canShowMetadata, product, intl]);
+
+  const displayPrice = useMemo(() => {
+    if (!canPurchase) {
+      return null;
+    }
+
+    if (offering.rules.discounted_price != null) {
+      return (
+        <>
+          <span id="original-price" className="offscreen">
+            <FormattedMessage {...messages.original_price} />
+          </span>
+          <del aria-describedby="original-price" className="product-widget__price-discounted">
+            <FormattedNumber
+              currency={product.price_currency}
+              value={product.price}
+              style="currency"
+            />
+          </del>
+          <span id="discount-price" className="offscreen">
+            <FormattedMessage {...messages.discounted_price} />
+          </span>
+          <ins aria-describedby="discount-price" className="product-widget__price-discount">
+            <FormattedNumber
+              currency={product.price_currency}
+              value={offering.rules.discounted_price}
+              style="currency"
+            />
+          </ins>
+        </>
+      );
+    }
+
+    return (
+      <FormattedNumber currency={product.price_currency} value={product.price} style="currency" />
+    );
+  }, [canPurchase, offering.rules.discounted_price, product.price]);
+
+  return (
+    <header className="product-widget__header">
+      <div className="product-widget__header-main">
+        <h3 className="product-widget__title">{product.title}</h3>
+      </div>
+      <strong className="product-widget__price h6">
+        {hasPurchased && <FormattedMessage {...messages.purchased} />}
+        {displayPrice}
+      </strong>
+      {offering?.rules.description && (
+        <p className="product-widget__header-description">{offering.rules.description}</p>
+      )}
+      {offering?.rules.discounted_price && (
+        <p className="product-widget__header-discount">
+          {offering.rules.discount_rate ? (
+            <span className="product-widget__header-discount-rate">
+              <FormattedNumber value={-offering.rules.discount_rate} style="percent" />
+            </span>
+          ) : (
+            <span className="product-widget__header-discount-amount">
+              <FormattedNumber
+                currency={product.price_currency}
+                value={-offering.rules.discount_amount!}
+                style="currency"
+              />
+            </span>
+          )}
+          {offering.rules.discount_start && (
+            <span className="product-widget__header-discount-date">
+              &nbsp;
+              <FormattedMessage
+                {...messages.from}
+                values={{ from: formatDate(offering.rules.discount_start) }}
+              />
+            </span>
+          )}
+          {offering.rules.discount_end && (
+            <span className="product-widget__header-discount-date">
+              &nbsp;
+              <FormattedMessage
+                {...messages.to}
+                values={{ to: formatDate(offering.rules.discount_end) }}
+              />
+            </span>
+          )}
+        </p>
+      )}
+      {canShowMetadata && (
+        <>
+          <p
+            className="product-widget__header-metadata"
+            data-testid="product-widget__header-metadata-dates"
+          >
+            <Icon name={IconTypeEnum.CALENDAR} size="small" />
+            <FormattedMessage
+              {...messages.fromTo}
+              values={{
+                from: formatDate(minDate!),
+                to: formatDate(maxDate),
+              }}
+            />
+          </p>
+          <p
+            className="product-widget__header-metadata"
+            data-testid="product-widget__header-metadata-languages"
+          >
+            <Icon name={IconTypeEnum.LANGUAGES} size="small" />
+            <FormattedMessage {...messages.availableIn} values={{ languages }} />
+          </p>
+        </>
+      )}
+    </header>
+  );
+};
+const Content = ({ product, order }: { product: Product; order?: CredentialOrder }) => {
+  const targetCourses = useMemo(() => {
+    if (order) {
+      return order.target_courses;
+    }
+
+    if (product) {
+      return product.target_courses;
+    }
+
+    return [];
+  }, [product, order]);
+
+  return (
+    <ol className="product-widget__content">
+      {Children.toArray(
+        targetCourses.map((target_course) => (
+          <CourseRunItem key={target_course.code} targetCourse={target_course} order={order} />
+        )),
+      )}
+      {product.certificate_definition && (
+        <CertificateItem certificateDefinition={product.certificate_definition} order={order} />
+      )}
+    </ol>
+  );
+};
+
+const CourseProductItem = ({ productId, course, compact = false }: CourseProductItemProps) => {
+  // FIXME(rlecellier): useCourseProduct need's a filter on product.type that only return
+  // CredentialOrder
+  const { item: offering, states: productQueryStates } = useCourseProduct(
+    {
+      product_id: productId,
+      course_id: course.code,
+    },
+    {
+      refetchOnMount: 'always',
+      refetchOnWindowFocus: 'always',
+    },
+  );
+
+  const product = offering?.product;
+  const { item: productOrder, states: orderQueryStates } = useProductOrder({
+    productId,
+    courseCode: course.code,
+  });
+
+  const order = productOrder as CredentialOrder;
+  const canPurchase = OrderHelper.isPurchasable(order);
+  const hasPurchased = OrderHelper.isActive(order);
+  const canEnroll = OrderHelper.allowEnrollment(order);
+
+  const hasError = Boolean(productQueryStates.error);
+  const isFetching = productQueryStates.fetching || orderQueryStates.fetching;
+  const canShowContent = !compact || canEnroll;
+
+  useEffect(() => {
+    if (product && product.type !== ProductType.CREDENTIAL) {
+      handle(
+        new Error(
+          `Cannot render product "${product.type}" (${product.id}) through CourseProductItem on course ${course.code}`,
+        ),
+      );
+    }
+  }, [product]);
+
+  if (product && product.type !== ProductType.CREDENTIAL) {
+    // CourseProductItem only handle CREDENTIAL products
+    return null;
+  }
+
+  return (
+    <section
+      className={c('product-widget', {
+        'product-widget--has-error': hasError,
+        'product-widget--compact': compact,
+        'product-widget--purchased': hasPurchased,
+      })}
+    >
+      {isFetching && (
+        <div className="product-widget__overlay">
+          <Spinner aria-labelledby="loading-course" theme="light" size="large">
+            <span id="loading-course">
+              <FormattedMessage {...messages.loading} />
+            </span>
+          </Spinner>
+        </div>
+      )}
+      {hasError && (
+        <p className="product-widget__content">
+          <Icon name={IconTypeEnum.WARNING} size="small" />
+          {productQueryStates.error}
+        </p>
+      )}
+      {!hasError && product && (
+        <>
+          <Header
+            product={product}
+            order={order}
+            offering={offering}
+            canPurchase={canPurchase}
+            hasPurchased={hasPurchased}
+            compact={compact}
+          />
+          {canShowContent && <Content product={product} order={order} />}
+          <footer className="product-widget__footer">
+            <CourseProductItemFooter
+              course={course}
+              offering={offering}
+              canPurchase={canPurchase}
+            />
+          </footer>
+        </>
+      )}
+    </section>
+  );
+};
+
+export default CourseProductItem;