https://github.com/henriqueslab/liquidenginecookiecutter
https://github.com/henriqueslab/liquidenginecookiecutter
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/henriqueslab/liquidenginecookiecutter
- Owner: HenriquesLab
- License: cc-by-4.0
- Created: 2024-01-30T11:38:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T16:03:41.000Z (almost 2 years ago)
- Last Synced: 2024-07-17T19:48:55.234Z (almost 2 years ago)
- Language: Python
- Size: 67.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# LiquidEngineCookiecutter
Liquid Engine template made using [cookiecutter](https://cookiecutter.readthedocs.io/en/stable/)!
It helps create a python package and implements a simple class that subclasses the [Nanopyx Liquid Engine](https://github.com/HenriquesLab/NanoPyx).
### A video tutorial is available!
[](http://www.youtube.com/watch?v=s2SY6IlsWQI "How to Create a Python Package with the Liquid Engine")
# How to use
## Install cookiecutter
```bash
pip install cookiecutter
```
## Generate package folder structure
First, navigate to a folder where you want your package to live.
```bash
cookiecutter https://github.com/HenriquesLab/LiquidEngineCookieCutter
```
Cookiecutter will ask you for information regarding the package you want to create.
After this step is complete a new folder will appear in your working directory.
## Install the new package
First navigate to the newly created folder:
```bash
cd MyLiquidEngineFolder
pip install -e .
```
This installation should also install the newest version of nanopyx and required dependencies. Alongside this example you can find example tests that you can run with `pytest`.
```bash
pytest
```
This template also shows how you can use nox to test on multiple python versions and in clean temporary environments. Run the helper script `runNoxTools.py` python script to spawn a nox testing session.
```bash
python runNoxTools.py
```
You now have a minimal working example of a Liquid Engine class.
---
### TIPS:
1. After any modification to the Liquid Engine class (or any other .pyx file) you will need to recompile.
```bash
python setup.py build_ext --inplace
```
2. This cookiecutter showcases how the the Mako templating engine is used within the Liquid Engine. Before compilation all templates are rendered and moved to their respective folders overriding any old files with the same name. This means that if you to edit the example files you need to do it on the corresponding Mako template. If you don't want to rely on templating delete the files inside ```src/mako_templates``` and edit the files as usual.
3. Using a Mako template entails writing a template file in the mako_templates folder. The name of the file should represent the relative path where the rendered template should live. All templates are rendered at compile time. For more information check out the [Mako official documentation](https://docs.makotemplates.org/en/latest/index.html).
4. Depending on the use case you might want to overload some of the functions that the Liquid Engine base class provides. See [Tutorial ‐ Implementing Liquid Engine Methods](https://github.com/HenriquesLab/LiquidEngine/wiki/Tutorial-%E2%80%90-Implementing-Liquid-Engine-Methods) for more information.