JoanGiner's picture
fixed normal readme
0155ff7

A newer version of the Streamlit SDK is available: 1.48.1

Upgrade

The Software Diversity Card webform generator 🏢

Welcome to the Software Diversity Card Generator—a form-based application designed to empower you to highlight and promote diversity in software projects. Our innovative tool helps you generate comprehensive diversity cards in both JSON and Markdown formats, offering a transparent overview of the varied teams involved in development and governance, the user groups engaged in testing, and the tailored software adaptations for different social groups. By providing a structured model, an extended JSON syntax, and a toolkit backed by real-world examples, our platform aims to foster inclusive practices that can be embraced by open-source communities, academic journals, and forward-thinking businesses alike.

Public demo and other tools

We have released a public demo of the web-form generator at: www.dummy.org

Do you prefer filling the card using your favourite IDE? Try out the Visual Studio Code language pluguin here: www.vscodemarket.org/ourtool

Dependencies

It is recommended to use a virtual environment, i.e., the following commands should be run before installing the dependencies:

python3 -m venv .venv
source .venv/bin/activate

This project relies on Streamlit 1.x. To install the dependencies run:

pip install -r requirements.txt 

Running the service

After setting up the virtual environment and installing the dependencies, run the following command to start the server:

streamlit run server.py

The streamlit listening port can be customized by setting the --server.port parameter:

streamlit run server.py --server.port 2000