Filester: generic, file based utilities and helpers

• Overview
• Prerequisites
• Getting Started
  • (macOS Users only) upgrading GNU make
  • Creating the local environment
  • Local environment maintenance
• Help
• Running the Test Harness

Overview

Find yourself running the same file based operations over and over again in your projects? Yeah, annoying. As a result, this package is a grouping of common file operation facilities which delegate the package inclusion to pip and PyPI. One less thing to worry about ...

See Filester's documentation for more information.

top

Prerequisites

• GNU make
• Python 3 Interpreter. We recommend installing pyenv
• Docker

top

Getting Started

Makester is used as the Integrated Developer Platform.

(macOS Users only) upgrading GNU make

Follow these notes to get [GNU make](https://www.gnu.org/s oftware/make/manual/make.html).

Creating the local environment

Get the code and change into the top level git project directory:

git clone git@github.com:loum/filester.git && cd filester

NOTE: Run all commands from the top-level directory of the git repository.

For first-time setup, prime the Makester project:

git submodule update --init

Initialise the environment:

make init-dev

Local environment maintenance

Keep Makester project up-to-date with:

git submodule update --remote --merge

top

Help

There should be a make target to get most things done. Check the help for more information:

make help

top

Running the Test Harness

We use pytest. To run the tests:

make tests

top