h-vialib 1.0.5

Library functions for use with Via

h-vialib

Library functions for use with Via

Usage

This is an internal library, mostly of interest to maintainers of Via and related components.

Some items of interest:

• Configuration - Configuration parameter management

Hacking

Installing h-vialib in a development environment

You will need

• Git

• pyenv Follow the instructions in the pyenv README to install it. The Homebrew method works best on macOS. On Ubuntu follow the Basic GitHub Checkout method.

Clone the git repo

git clone https://github.com/hypothesis/h-vialib.git

This will download the code into a h-vialib directory in your current working directory. You need to be in the h-vialib directory for the rest of the installation process:

cd h-vialib

Run the tests

make test

That's it! You’ve finished setting up your h-vialib development environment. Run make help to see all the commands that're available for linting, code formatting, packaging, etc.

Updating the Cookiecutter scaffolding

This project was created from the https://github.com/hypothesis/h-cookiecutter-pypackage/ template. If h-cookiecutter-pypackage itself has changed since this project was created, and you want to update this project with the latest changes, you can "replay" the cookiecutter over this project. Run:

make template

This will change the files in your working tree, applying the latest updates from the h-cookiecutter-pypackage template. Inspect and test the changes, do any fixups that are needed, and then commit them to git and send a pull request.

If you want make template to skip certain files, never changing them, add these files to "options.disable_replay" in .cookiecutter.json and commit that to git.

If you want make template to update a file that's listed in disable_replay simply delete that file and then run make template, it'll recreate the file for you.