Changelog

Unreleased

Changed

4.1.3 (2022-06-03)

Fixed

4.1.2 (2021-12-18)

Fixed

4.1.1 (2021-11-02)

Fixed

  • Fix _ensure_dir() when a folder-less path is used

    If a folder-less path, like “file.txt” is passed, then os.path.dirname(Path(path)) results in “”, instead of “.”, like we want. This causes mkdir() to fail. This fixes it, and adds a test for it. The test fails without the change.

    Fixes https://github.com/staticjinja/staticjinja/issues/160

4.1.0 (2021-07-31)

Added

4.0.0 (2021-07-18)

Added

  • --log argument to CLI to set log level.

Removed

  • Removed logger argument to Site(). Use staticjinja.logger for the staticjinja-wide logger instead. See https://github.com/staticjinja/staticjinja/issues/144
  • Removed Renderer class and make_renderer function. Remove the bare make_site function, use Site.make_site instead. All of this was deprecated 6 years ago, no one should still be using them.

3.0.1 (2021-07-02)

Fixed

  • Formatting error in this changelog.

3.0.0 (2021-07-02)

Changed

  • Calling python3 -m staticjinja now works exactly the same as calling staticjinja directly. If you were using python3 -m staticjinja, this probably broke you, you now need to explicitly give the watch subcommand with python3 -m staticjinja watch. For more info see https://github.com/staticjinja/staticjinja/issues/152.

2.1.0 (2021-06-10)

Deprecated

  • Deprecate inferring project root directory from build script directory. In the future, if staticjinja ever receives a relative path, it will use the CWD as the root. If you rely upon the location of your build script that uses the staticjinja API, then you may need to change. If you’re just using the CLI, then you don’t need to change anything. See https://github.com/staticjinja/staticjinja/issues/149 for more info.

2.0.1 (2021-05-21)

Added

  • A failed attempt at auto release when the version number is bumped. Nothing actually changed here.

2.0.0 (2021-05-21)

Deprecated

Changed

  • Improved CLI help message formatting
  • Revert the change made in #71_. Ensuring output locations exist should be the responsibility of the custom render function, since there’s no guarantee what output locations the custom render function might use. This might only affect those using custom render functions.
  • Slightly changed the return type of Site.get_dependencies(). See https://github.com/staticjinja/staticjinja/commit/170b027a4fff86790bc69a1222d7b0a36c1080bc
  • Make Reloader piggyback off of Site’s logger, so we don’t have any bare print statements dangling about.

Added

Fixed

  • Fix and improve the markdown example.
  • Change from inspect.isfunction() -> callable(), per #143_. Now you should be able to use methods which are instance members of classes.
  • Docs: Fix docstring for Site.render_template.
  • Make Renderer call super() correctly. It’s deprecated, so probably no point, but might as well fix it.
  • Internal: Made flake8 check actually runs against files, other small fixups

1.0.4 (2021-02-02)

Changed

  • Contributing info is updated/improved.
  • CLI help message is better formatted and more useful. How it works shouldn’t have changed.
  • Internal: Use poetry as our package manager. This should change the development workflow but not the user experience.
  • Internal: Moved many tests/checks out of tox and into Makefile.
  • Internal: Use black as our formatter.
  • Improve some tests and add some more CLI tests.

1.0.3 (2021-01-24)

Fixed

  • Fix links to external APIs in docs.
  • Use the real readthedocs html theme when building docs locally.

1.0.2 (2021-01-22)

Fixed

  • Fix token to actions/create-release@v1 in publish workflow
  • Fix links throughout project.

1.0.1 (2021-01-22)

Fixed

  • Pin upload to PyPI action (pypa/gh-action-pypi-publish, used in the publish workflow) to @v1.4.1, instead of just @master. Less prone to breakage.

1.0.0 (2021-01-19)

Added

Changed

  • Use GitHub Actions instead of Travis CI for CI testing.
  • Out directory no longer needs to exist in CLI.
  • Add more default arguments (logger, outpath, and encoding) to Site.__init__() so that Site.make_site() doesn’t have to make them.
  • Update requirements using piptools. This dropped a dependency on pathtools.
  • Upload test results as artifacts to better diagnose failures in GitHub Actions.

Deprecated

Removed

  • Python 2, 3.4, and 3.5 support. Now only Python 3.6 to 3.9 is supported.
  • Remove broken filepath arg from Site.render_templates(). You shouldn’t notice this though, since it crashed if was used :)

Fixed

  • Fix tests and __main__.py to use Site.make_site(), not deprecated staticjinja.make_site().
  • Tests are now split up into separate files in the tests/ directory. The one monolithic file was intimidating. Some repeated boilerplate tests were parameterized as well. The tests could still use some more cleanup in general.
  • Overhaul contributing info. Port CONTRIBUTING.md over to CONTRIBUTING.rst, edit it, and then import this version in docs.
  • Fix CWD logic loophole if Site.make_site() is called from an interpreter.
  • Update use of deprecated inspect.getargspec().
  • A few other trivial fixes.

0.4.0 (2020-11-14)

  • Improve Travis CI testing: Add Windows and OSX, stop testing python2, add newer python3 versions, update tox.ini.
  • Convert all print()s to logger.logs().
  • Make CLI interface use Site.make_site() instead of deprecated make_site().
  • Simplify style and how kwargs are passed around.
  • Single-source the version info so it’s always consistent.
  • Minor fixes, updates, improvements to README, AUTHORS, CONTRIBUTING, setup.py, __init__.py docstring,
  • Rename Site._env to Site.env, making it publicly accessible, for instance in custom rendering functions.
  • Fix docstring for the expected signature of custom rendering rules so they expect a staticjinja.Site as opposed to a jinja2.Environment
  • Make is_{template,static,ignored,partial} functions be consistent with taking template names(always use /), not file names (use os.path.sep), making them consistent between OSs. https://github.com/staticjinja/staticjinja/issues/88
  • Update and improve docs, add .readthedocs.yml so that ReadTheDocs.org can automatically pull from the repo and build docs on changes. Add a badge for if the doc build passes. Add readthedocs build task as a GitHub check, so new PRs and branches will automatically get this check.
  • Change single example/ directory to a collection of examples in examples/, and add in an example for using custom rendering rules to generate HTML from markdown. This also fixes the totally wrong tutorial on the docs for how to use custom rendering rules. See https://github.com/staticjinja/staticjinja/pull/102
  • Update dependencies using pip-tools to automatically generate indirect dependencies from direct dependencies:
    • jinja2==2.6 -> jinja2==2.11.2
    • argh==0.21.0 -> REMOVED
    • argparse==1.2.1 -> REMOVED
    • docopt==0.6.1 -> docopt==0.6.2
    • easywatch==0.0.5 -> easywatch==0.0.5
    • pathtools==0.1.2 -> pathtools==0.1.2
    • watchdog==0.6.0 -> watchdog==0.10.3
    • wsgiref==0.1.2 -> REMOVED
    • NONE -> markupsafe==1.1.1

0.3.5 (2018-08-16)

  • Make README less verbose.
  • Only warn about using deprecated staticpaths if staticpaths is actually used.
  • Updated easywatch to 0.0.5

0.3.4 (2018-08-14)

  • Move make_site() to Site.make_site().
  • Deprecate staticpaths argument to Site() and Site.make_site(). See Issue #58.
  • Add an option (default True) for Jinja’s FileSystemLoader follow to symlinks when loading templates.
  • Ensure that the output directory exists, regardless of whether custom rendering rules were supplied. Before that was only ensured if custom rendering rules were not given.
  • License file is included now in distributions.
  • Add documentation for partial and ignored files.
  • Updated easywatch to 0.0.4.
  • Fix a few style errors.

0.3.3 (2016-03-08)

  • Enable users to direct pass dictionaries instead of context generator in Site and make_site() for contexts that don’t require any logic.
  • Introduces a mergecontexts parameter to Site and make_site() to direct staticjinja to either use all matching context generator or only the first one when rendering templates.

0.3.2 (2015-11-23)

  • Allow passing keyword arguments to jinja2 Environment.
  • Use shutil.copy2 instead of shutil.copyfile when copying static resources to preserve the modified time of files which haven’t been modified.
  • Make the Reloader handle “created” events to support editors like Pycharm which save by first deleting then creating, rather than modifying.
  • Update easywatch dependency to 0.0.3 to fix an issue that occurs when installing easywatch 0.0.2.
  • Make --srcpath accept both absolute paths and relative paths.
  • Allow directories to be marked partial or ignored, so that all files inside them can be considered partial or ignored. Without this, developers would need to rename the contents of these directories manually.
  • Allow users to mark a single file as static, instead of just directories.

0.3.1 (2015-01-21)

  • Add support for filters so that users can define their own Jinja2 filters and use them in templates:

    filters = {
        'filter1': lambda x: "hello world!",
        'filter2': lambda x: x.lower()
    }
    site = staticjinja.make_site(filters=filters)
    
  • Add support for multiple static directories. They can be passed as a string of comma-separated names to the CLI or as a list to the Renderer.

  • “Renderer” was renamed to “Site” and the Reloader was moved staticjinja.reloader.

0.3.0 (2014-06-04)

  • Add a command, staticjinja, to handle the simple case of building context-less templates.
  • Add support for copying static files from the template directory to the output directory.
  • Add support for testing, linting and checking the documentation using tox.

0.2.0 (2014-01-04)

  • Add a Reloader class.
  • Add Renderer.templates, which refers to the lists of templates available to the Renderer.
  • Make Renderer.get_context_generator() private.
  • Add Renderer.get_dependencies(filename), which gets every file that depends on the given file.
  • Make Renderer.render_templates() require a list of templates to render, templates.