mattiadg / demo_it-analyze

Demo to show the joy of working with automation for developer experience

Demo_It-analyze

---

Table of Contents

• Introduction
• Installation
• License

Introduction

demo-it-analyze is a toy package attached to the Medium article Without Further Ado: Automate Dev Environments and Build to show python automation tools for creating environments and building a package.

Installation

demo-it-analyze is distributed via pypi and can be installed with

pip install demo-it-analyze

However, this package is not meant to be used as a library. Its distribution is for illustrative purpose only.

Usage

The automation is based on hatch for environment managing, building and publishing. Installation of hatch is recommended with pipx

pipx install hatch

A dev environment can be created with

hatch env create

but this command is not usually required. Rather, commands can be run with

hatch run command

and hatch will automatically create a dev environment (called default) and run the command within it.

The server for this program can be run with

hatch run serve

and a flask server will start on localhost:5001. Currently, it only exposes a single endpoint at localhost:5001/ner and it is defined here.

Tests can be run on all available python versions in the machine (>= 3.7, <=3.11) with

hatch run test:cov

This command creates an environment called test, which defines a matrix of environments with different python versions. Commands are run in all applicable environments if none is specified.

License

demo-it-analyze is distributed under the terms of the MIT license.