frkl.project-meta

Manage and display metadata for a project created with the frkl.python-project template.

Description

Documentation still to be done.

Downloads

Binaries

Development

Requirements

Python (version >=3.6)
pip, virtualenv
git
make
direnv (optional)

Prepare development environment

Notes:

if using direnv, adjust the Python version in .envrc (should not be necessary)
if not using direnv, you have to setup and activate your Python virtualenv yourself, manually, before running make init

git clone https://gitlab.com/frkl/frkl.project-meta
cd frkl.project-meta
mv .envrc.disabled .envrc
direnv allow   # if using direnv, otherwise activate virtualenv
make init

`make` targets

init: init development project (install project & dev dependencies into virtualenv, as well as pre-commit git hook)
binary: create binary for project (will install pyenv -- check scripts/build-binary for details)
flake: run flake8 tests
mypy: run mypy tests
test: run unit tests
docs: create static documentation pages
serve-docs: serve documentation pages (incl. auto-reload)
clean: clean build directories

For details (and other, minor targets), check the Makefile.

Running tests

> make test
# or
> make coverage

Update project template

This project uses cruft to apply updates to the base Python project template to this repository. Check out it's documentation for more information.

cruft update
# interactively approve changes, make changes if necessary
git add *
git commit -m "chore: updated project from template"

Copyright & license

Please check the LICENSE file in this repository (it's a short license!).

Parity Public License 6.0.0

makkus/frkl.project-meta