Skip to main content

Kiara plugin for html-related tasks.

Project description

PyPI status PyPI version PyPI pyversions Build Status Coverage Status Code style

kiara plugin: (html)

Kiara plugin for html-related tasks.

Description

TODO

Development

Requirements

  • Python (version >= 3.8)
  • pip, virtualenv
  • git
  • make (on Linux / Mac OS X -- optional)

Prepare development environment

If you only want to work on the modules, and not the core Kiara codebase, follow the instructions below. Otherwise, please check the notes on how to setup a Kiara development environment under (TODO).

Linux & Mac OS X (using make)

For *NIX-like operating system, setting up a development environment is relatively easy:

git clone https://github.com/DHARPA-Project/kiara_plugin.html.git
cd kiara_plugin.html
python3 -m venv .venv
source .venv/bin/activate
make init

Windows (or manual pip install)

It's impossible to lay out all the ways Python can be installed on a machine, and virtual- (or conda-)envs can be created, so I'll assume you know how to do this. One simple way is to install the Anaconda (individual edition), then use the Anaconda navigator to create a new environment, install the 'git' package in it (if your system does not already have it), and use the 'Open Terminal' option of that environment to start up a terminal that has that virtual-/conda-environment activated.

Once that is done, cd into a directory where you want this project folder to live, and do:

# make sure your virtual env is activated!!!
git clone https://github.com/DHARPA-Project/kiara_plugin.html.git
cd kiara_plugin.html
pip install --extra-index-url https://pypi.fury.io/dharpa/ -U -e .[all_dev]

Try it out

After this is done, you should be able to run the included example module via:

kiara run html_example text_1="xxx" text_2="yyy"
...
...

Re-activate the development environment

The 'prepare' step from above only has to be done once. After that, to re-enable your virtual environment, you'll need to navigate to the directory again (wherever that is, in your case), and run the source command from before again:

cd path/to/kiara_plugin.html
source .venv/bin/activate  # if it isn't activated already, for example by the Anaconda navigator
kiara --help  # or whatever, point is, kiara should be available for you now,

make targets (Linux & Mac OS X)

  • init: init development project (install project & dev dependencies into virtualenv, as well as pre-commit git hook)
  • update-dependencies: update development dependencies (mainly the core kiara package from git)
  • flake: run flake8 tests
  • mypy: run mypy tests
  • test: run unit tests
  • docs: create static documentation pages (under build/site)
  • serve-docs: serve documentation pages (incl. auto-reload) for getting direct feedback when working on documentation
  • clean: clean build directories

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

Running tests

> make test
# or
> make coverage

Copyright & license

This project is MPL v2.0 licensed, for the license text please check the LICENSE file in this repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kiara_plugin.html-0.5.0.tar.gz (52.6 kB view details)

Uploaded Source

Built Distribution

kiara_plugin.html-0.5.0-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

Details for the file kiara_plugin.html-0.5.0.tar.gz.

File metadata

  • Download URL: kiara_plugin.html-0.5.0.tar.gz
  • Upload date:
  • Size: 52.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for kiara_plugin.html-0.5.0.tar.gz
Algorithm Hash digest
SHA256 73e00cfb90d1ad3515b9a5a9f38feb25dace03a9d3bdd6494ba4361cb62b65b5
MD5 eca15f929a4658a7dc432fd08facdc19
BLAKE2b-256 f5d6cf34955579a32b9ebbd2df6f80964c935373ca62e485d50d4d6640017092

See more details on using hashes here.

File details

Details for the file kiara_plugin.html-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kiara_plugin.html-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3360b579c4bbbeac2a881510ede92ad61967472e355d5021a967992f1829c88b
MD5 45cf7256af1f44a393df62a1e758000c
BLAKE2b-256 215143c139a1f706ec796458245472ef9ffc78a5da79f9263d1d7f49c5c05f62

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page