From 6aba756f222e3daf0c15c4e5bb664d549ec6c14b Mon Sep 17 00:00:00 2001 From: Dominic Thorn Date: Thu, 8 Apr 2021 08:46:40 +0100 Subject: [PATCH 1/2] Update documentation --- README.md | 12 +++--------- docs/index.md | 10 ++++++---- pyproject.toml | 7 +++++-- 3 files changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3c92dee..81051ed 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,15 @@ esparto [![codecov](https://codecov.io/gh/domvwt/esparto/branch/main/graph/badge.svg?token=35J8NZCUYC)](https://codecov.io/gh/domvwt/esparto) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=domvwt_esparto&metric=alert_status)](https://sonarcloud.io/dashboard?id=domvwt_esparto) - -A simple toolkit for creating accessible and shareable HTML documents. +Esparto is a minimal frontend web framework written in Python. +It aims to be the first choice for designing self-contained documents with productivity as the main concern. Full documentation available at [domvwt.github.io/esparto/](https://domvwt.github.io/esparto/). ### Features * Lightweight API -* Familiar and accessible page format +* No CSS or HTML required * Device responsive display * Self contained / inline dependencies * Jupyter Notebook support * MIT License - - -This package was created with -[Cookiecutter](https://github.com/audreyr/cookiecutter) and the -[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) -project template. diff --git a/docs/index.md b/docs/index.md index 6aa5a53..71c6665 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,12 @@ # Welcome -Esparto is a simple toolkit for creating accessible and shareable HTML documents. +Esparto is a minimal frontend web framework written in Python. +It aims to be the first choice for designing self-contained documents with productivity as the main concern. + +## Overview The library provides a streamlined API that lets users define their page in terms of sections, rows, and columns; and an intelligent wrapping system that automatically -converts content to a format compatible with modern web browsers. +converts Python objects into content. -## Overview We use the grid system and components from [Bootstrap](https://getbootstrap.com/) to ensure documents adapt to the viewing device and appear immediately familiar and accessible. No knowledge of Bootstrap or web development is required to use the library, however, as these @@ -19,7 +21,7 @@ and iteratively build documents without disrupting their workflow. ## Features * Lightweight API * Jupyter Notebook support -* Familiar and accessible page format +* No CSS or HTML required * Device responsive display * Self contained / inline dependencies * MIT License diff --git a/pyproject.toml b/pyproject.toml index 0d5386a..f033040 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,9 +1,12 @@ [tool.poetry] name = "esparto" -version = "0.1.0" -description = "Simple toolkit for building accessible and shareable HTML documents." +version = "0.1.1" +description = "Minimal frontend web framework written in Python." authors = ["Dominic Thorn "] license = "MIT" +readme = "README.md" +homepage = "https://domvwt.github.io/esparto" +repository = "https://github.com/domvwt/esparto" [tool.poetry.dependencies] python = "^3.6.1" From c2a9c876f58a919209712fbe7282f840543a20dc Mon Sep 17 00:00:00 2001 From: Dominic Thorn Date: Thu, 8 Apr 2021 11:53:44 +0100 Subject: [PATCH 2/2] Update release notes --- docs/04-about/release-notes.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/04-about/release-notes.md b/docs/04-about/release-notes.md index 09cbaea..3de373c 100644 --- a/docs/04-about/release-notes.md +++ b/docs/04-about/release-notes.md @@ -1,6 +1,12 @@ Release Notes ============= +0.1.1 (2021-04-08) +------------------ + +- Update package metadata for pypi. + + 0.1.0 (2021-04-07) ------------------