journalyze 0.1.0

A journaling prompt library

Journalyze

A Python library to facilitate the journinaling experience.

Overview

Journalyze:

• Fetches journaling prompts

Installation

pip install journalyze

How to Use

After installing the library, there are currently 3 functions available for use.

Simply import * from journalyze, and then call any of the following functions:

get_prompt()

getPrompt() randomly selects a prompt from the list of prompts in csv file

add_prompt()

add_prompt() adds a new prompt to the list of prompts in csv file

remove_prompt()

remove_prompt() removes a prompt from the list of prompts in csv file

Details

This project is a pure python project using modern tooling. It uses a Makefile as a command registry, with the following commands:

• make: list available commands
• make develop: install and build this library and its dependencies using pip
• make build: build the library using setuptools
• make lint: perform static analysis of this library with flake8 and black
• make format: autoformat this library using black
• make annotate: run type checking using mypy
• make test: run automated tests with pytest
• make coverage: run automated tests with pytest and collect coverage information
• make dist: package library for distribution