From fc9a8dc4613e6042af2ff2832abae3282baffb31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Corentin=20S=C3=A9chet?= Date: Tue, 21 May 2024 22:36:52 +0200 Subject: [PATCH] refactor: get a shorter name --- .gitignore | 2 +- {jwebsite => jweb}/__init__.py | 0 {jwebsite => jweb}/cli.py | 2 +- {jwebsite => jweb}/content.py | 0 {jwebsite => jweb}/context.py | 2 +- {jwebsite => jweb}/extensions/git.py | 4 ++-- {jwebsite => jweb}/extensions/markdown.py | 4 ++-- {jwebsite => jweb}/extensions/yaml.py | 4 ++-- {jwebsite => jweb}/git.py | 2 +- noxfile.py | 2 +- pyproject.toml | 8 ++++---- tests/extensions/test_markdown.py | 10 +++++----- tests/extensions/test_yaml.py | 8 ++++---- tests/test_context.py | 2 +- tests/test_context/locale/fr/LC_MESSAGES/tests.po | 2 +- 15 files changed, 26 insertions(+), 26 deletions(-) rename {jwebsite => jweb}/__init__.py (100%) rename {jwebsite => jweb}/cli.py (87%) rename {jwebsite => jweb}/content.py (100%) rename {jwebsite => jweb}/context.py (99%) rename {jwebsite => jweb}/extensions/git.py (91%) rename {jwebsite => jweb}/extensions/markdown.py (91%) rename {jwebsite => jweb}/extensions/yaml.py (86%) rename {jwebsite => jweb}/git.py (94%) diff --git a/.gitignore b/.gitignore index 9e73285..abb19e8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ **/__pycache__ .coverage -jean_website.egg-info +jean_web.egg-info tests/**/*.mo diff --git a/jwebsite/__init__.py b/jweb/__init__.py similarity index 100% rename from jwebsite/__init__.py rename to jweb/__init__.py diff --git a/jwebsite/cli.py b/jweb/cli.py similarity index 87% rename from jwebsite/cli.py rename to jweb/cli.py index 42d4659..9abfc68 100644 --- a/jwebsite/cli.py +++ b/jweb/cli.py @@ -2,7 +2,7 @@ from pathlib import Path from click import group -from jwebsite.context import Context +from jweb.context import Context @group diff --git a/jwebsite/content.py b/jweb/content.py similarity index 100% rename from jwebsite/content.py rename to jweb/content.py diff --git a/jwebsite/context.py b/jweb/context.py similarity index 99% rename from jwebsite/context.py rename to jweb/context.py index 587dfd6..6ef44dc 100644 --- a/jwebsite/context.py +++ b/jweb/context.py @@ -10,7 +10,7 @@ from jinja2.environment import Environment from jinja2.loaders import FileSystemLoader from jinja2.runtime import Context as JinjaContext -from jwebsite.content import Content +from jweb.content import Content _DEFAULT_LANGUAGE = "en" diff --git a/jwebsite/extensions/git.py b/jweb/extensions/git.py similarity index 91% rename from jwebsite/extensions/git.py rename to jweb/extensions/git.py index 3382fc5..f8ca5ba 100644 --- a/jwebsite/extensions/git.py +++ b/jweb/extensions/git.py @@ -1,8 +1,8 @@ from datetime import datetime from subprocess import check_output -from jwebsite.content import Content -from jwebsite.context import Context +from jweb.content import Content +from jweb.context import Context def load_extension(context: Context) -> None: diff --git a/jwebsite/extensions/markdown.py b/jweb/extensions/markdown.py similarity index 91% rename from jwebsite/extensions/markdown.py rename to jweb/extensions/markdown.py index c2306ac..952df31 100644 --- a/jwebsite/extensions/markdown.py +++ b/jweb/extensions/markdown.py @@ -2,8 +2,8 @@ from typing import Any from markdown import Markdown -from jwebsite.content import Content, ContentField -from jwebsite.context import Context +from jweb.content import Content, ContentField +from jweb.context import Context def load_extension(context: Context) -> None: diff --git a/jwebsite/extensions/yaml.py b/jweb/extensions/yaml.py similarity index 86% rename from jwebsite/extensions/yaml.py rename to jweb/extensions/yaml.py index 6824fe5..c9bd46f 100644 --- a/jwebsite/extensions/yaml.py +++ b/jweb/extensions/yaml.py @@ -2,8 +2,8 @@ from typing import Any from yaml import Loader, load -from jwebsite.content import Content, ContentField -from jwebsite.context import Context +from jweb.content import Content, ContentField +from jweb.context import Context def load_extension(context: Context) -> None: diff --git a/jwebsite/git.py b/jweb/git.py similarity index 94% rename from jwebsite/git.py rename to jweb/git.py index 8b4bfc1..c3a2cc3 100644 --- a/jwebsite/git.py +++ b/jweb/git.py @@ -1,7 +1,7 @@ from datetime import datetime from subprocess import check_output -from jwebsite.content import Content +from jweb.content import Content def git_creation_date(content: Content) -> datetime: diff --git a/noxfile.py b/noxfile.py index 99b8b08..2cac530 100644 --- a/noxfile.py +++ b/noxfile.py @@ -52,7 +52,7 @@ def unit_tests(session: Session) -> None: session.install("babel", "jinja2") for directory in _LOCALIZED_TESTS: session.run("pybabel", "compile", "--domain=tests", f"--directory={directory}/locale", "--use-fuzzy") - session.run("python", "-m", "pytest", "--cov=jwebsite", "--cov-report=html") + session.run("python", "-m", "pytest", "--cov=jweb", "--cov-report=html") @session() diff --git a/pyproject.toml b/pyproject.toml index 5b87fc0..3e4c238 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,8 +1,8 @@ [project] -name = "jean-website" +name = "jean-web" version = "0.0.1" authors = [ - {name = "Jean-Website", email ="team@collectivit.org"} + {name = "Jean-Web", email ="team@collectivit.org"} ] description = "Static site generator" @@ -29,14 +29,14 @@ dev = [ ] [project.scripts] -jwebsite = "jwebsite.cli:main" +jweb = "jweb.cli:main" [build-system] requires = ["setuptools>=45"] [tool.mypy] strict = true -files = "jwebsite/**/*.py,tests/**/*.py,noxfile.py" +files = "jweb/**/*.py,tests/**/*.py,noxfile.py" [tool.ruff] line-length = 110 diff --git a/tests/extensions/test_markdown.py b/tests/extensions/test_markdown.py index b8ff72b..e99a7a5 100644 --- a/tests/extensions/test_markdown.py +++ b/tests/extensions/test_markdown.py @@ -2,14 +2,14 @@ from pathlib import Path from pytest import mark, raises -from jwebsite.content import Content -from jwebsite.context import Context +from jweb.content import Content +from jweb.context import Context @mark.parametrize("content", ["# Otters", b"# Otters"]) def test_load(datadir: Path, content: bytes | str) -> None: context = Context(datadir) - context.load_extensions("jwebsite.extensions.markdown") + context.load_extensions("jweb.extensions.markdown") context.render("test-load.html", "output.html", content=Content(Path("content.yml"), content, None)) with open(datadir / "build" / "output.html", encoding="utf-8") as ouput_file: @@ -18,7 +18,7 @@ def test_load(datadir: Path, content: bytes | str) -> None: def test_load_type_error(datadir: Path) -> None: context = Context(datadir) - context.load_extensions("jwebsite.extensions.markdown") + context.load_extensions("jweb.extensions.markdown") with raises(ValueError): context.render("test-load.html", "output.html", content=Content(Path("content.yml"), 10, None)) @@ -29,7 +29,7 @@ def test_load_type_error(datadir: Path) -> None: def test_metadata(datadir: Path) -> None: context = Context(datadir) - context.load_extensions("jwebsite.extensions.markdown") + context.load_extensions("jweb.extensions.markdown") markdown = "---\n" "title: Steven\n" "---\n" "\n" "Content\n" diff --git a/tests/extensions/test_yaml.py b/tests/extensions/test_yaml.py index 18ba789..54247f3 100644 --- a/tests/extensions/test_yaml.py +++ b/tests/extensions/test_yaml.py @@ -2,14 +2,14 @@ from pathlib import Path from pytest import mark, raises -from jwebsite.content import Content -from jwebsite.context import Context +from jweb.content import Content +from jweb.context import Context @mark.parametrize("content", ["[Peter, Steven]", b"[Peter, Steven]"]) def test_load(datadir: Path, content: bytes | str) -> None: context = Context(datadir) - context.load_extensions("jwebsite.extensions.yaml") + context.load_extensions("jweb.extensions.yaml") context.render("test-load.html", "output.html", content=Content(Path("content.yml"), content, None)) with open(datadir / "build" / "output.html", encoding="utf-8") as ouput_file: @@ -18,7 +18,7 @@ def test_load(datadir: Path, content: bytes | str) -> None: def test_load_type_error(datadir: Path) -> None: context = Context(datadir) - context.load_extensions("jwebsite.extensions.yaml") + context.load_extensions("jweb.extensions.yaml") with raises(ValueError): context.render("test-load.html", "output.html", content=Content(Path("content.yml"), 10, None)) diff --git a/tests/test_context.py b/tests/test_context.py index 210d711..c2c2620 100644 --- a/tests/test_context.py +++ b/tests/test_context.py @@ -1,6 +1,6 @@ from pathlib import Path -from jwebsite.context import Context +from jweb.context import Context def test_render(datadir: Path) -> None: diff --git a/tests/test_context/locale/fr/LC_MESSAGES/tests.po b/tests/test_context/locale/fr/LC_MESSAGES/tests.po index 8df3fab..1c3f1db 100644 --- a/tests/test_context/locale/fr/LC_MESSAGES/tests.po +++ b/tests/test_context/locale/fr/LC_MESSAGES/tests.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: PROJECT VERSION\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" -"POT-Creation-Date: 2024-05-21 21:13+0200\n" +"POT-Creation-Date: 2024-05-21 22:35+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: fr\n"