Skip to content

Run inventories for all the platforms that we are active on

Notifications You must be signed in to change notification settings

unfoldingWord/inventoryst

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Description

Inventoryst is a script to gather relevant information from all kinds of platforms and store that information into Markdown (.md) files. The intent is to have all relevant information ready in one place.

Setup and run

Manual

  1. Clone this repository
git clone unfoldingword/inventoryst
  1. Setup and activate Python virtual environment
cd inventoryst
python -m venv venv
source venv/bin/activate
  1. Install requirements
pip install -r requirements.txt
  1. Configure your .env file
    Use the file example.env for guidance

  2. Run the script

python main.py

Docker

  1. Pull the docker file
docker pull unfoldingword/inventoryst
  1. Configure the .env file
    Use the file example.env for guidance

  2. Run your container

docker run --rm --env-file=.env -v /path/to/markdown_files:/app/output unfoldingword/inventoryst

About

Run inventories for all the platforms that we are active on

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published