leibniz-hbi / smormlpy

A cookiecutter skeleton for SMO/MRML python tools.

smormlpy

A cookiecutter skeleton and style guide lines for SMO/MRML python tools.

---

Usage

This serves as our main repository on how to build tools and code. Additionally it comes with a cookiecutter-template which has the main features of our code-habits already integrated.

Version-Control

Documentation

To generate HTML/PDF documentation via pdoc3 run either of the following in your venv-shell:

• pdoc3 --html --http localhost:8090 your_new_project/ for an interactive preview of the HTML-docs.

Installation and Project Generation

1. Install poetry if you don't have it: pip install poetry.
2. Clone this repo, go into the repo's folder.
3. Install the dependencies with poetry install and spawn a shell in your new virtual environment with poetry shell.
4. Use cd .. to navigate to the parent directory.
5. Generate your new project: cookiecutter smormlpy. This will ask you a couple of questions about your new project, finally a new folder named after your new project will be created.
6. Leave the virtual environment of this repo using deactivate
7. Create a Git-repository in your newly created project folder.
8. Done, over and out.

---

2023, The Social Media Observatory Team under the MIT license.

smormlpy's Issues

add html-reports for pytest

add workflow for `pytest` on pull requests

see Leibniz-HBI/tegracli.

fix: flake8 instead of pylint?

PyLint can become very, very slow. Maybe use flake instead?

add google styleguide-based pylintrc

E.g. like that one https://raw.githubusercontent.com/google/seq2seq/master/pylintrc, although that one needs updating since it is for pylint <2.0.

Another issue is that black is stubbornly resisting a few points of the GSG. May be we should just conform black's style, @FlxVctr.

feat: best practice for `--version` in click

feat: autogenerate html-documentation on version bump

E.g. running the following fish-snippet will generate a new version of the documentation in a subfolder:

set TAG (git describe --tags --abbrev=0)
poetry run pdoc3 --html --output-dir docs/$TAG {{ cookiecutter.project_slug }} 

Improve compatability with Windows paths

$ cookiecutter smormlpy\
>
A valid repository for "smormlpy" could not be found in the following locations:
smormlpy
C:\Users\me/.cookiecutters/smormlpy

I had to type out the entire path to folder to get it to work. So: it works, but is quite clunky. Maybe the instructions can be adjusted accordingly or a better solution found?

[Idea] Static type checking with mypy

MyPy provides linting/checking of our code base on the basis of type annotations and provides additional safety to catch programing errors.

Update test setup

I.e. as mentioned here: Leibniz-HBI/dabapush#43.

fix: document decoupling and implement in example

smormlpy/{{ cookiecutter.project_slug }}/{{ cookiecutter.project_slug }}/main.py

Line 6 in fdf5624

def cli(name: str) -> None:

Can we find a different solution for this? If pdoc3 is not compatible with click, maybe we should use something else?

unpin package versions and correctly set python-version in pyproject.toml

Instructions for semantic versioning

https://mestrak.com/blog/semantic-release-with-python-poetry-github-actions-20nn

feat: add issue templates

Like so.

fix: addopts for `pytest` are wrong

update README with precommit-instructions

pytest-cov does not get the correct module name

[Idea] lint/convert/add docstrings with `pyment`

prepare GitHub template repo

correctly set python and package versions in pyproject