Modist

The client and cli interface for local Modist usage

Documentation

Getting Started

The client and cli interface for local Modist usage

Contributing

This document is to help you start development with this project.

Setup

You can fork and clone Modist at the GitHub repository. You will also need to work inside a virtual environment while developing this project. For this reason I recommend installing pipenv for working with this project.

You can install the dependencies of the project by running the command pipenv --three install --dev at the root of the repository. This should install all of the required dependencies for development.

—

You can run the project by creating a file (main.py) at the root of the repository. Here you can import the Modist package and debug your changes by running the command pipenv run main.py

Style Guides

This project uses flake8 as its primary style guide.

Changelog

All notable changes to Modist will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

unreleased

Modist Package

This is the base Modist package.

modist

Indices and tables

• Index
• Module Index
• Search Page