dsc-energy-academy-pipeline

A simple package to to process Figma designs and transform them into a standardised JSON format for the Sustainable Energy Academy.

Warning

The package is currently under active development. Some features may be missing or not working as intended. Feel free to open an issue.

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

The package can be installed directly from GitHub using pip:

pip install git+https://github.com/undp-data/dsc-energy-academy-pipeline

See VCS Support for more details. If you have cloned the repository, you can create a virtual environment and install the editable version of the package using the Makefile

python -m venv .venv
source .venv/bin/activate
make install

Usage

See main.ipynb which provides an brief introduction.

Contributing

All contributions must follow Conventional Commits. The codebase is formatted with black and isort. Use the provided Makefile for these routine operations.

1. Clone or fork the repository
2. Create a new branch (git checkout -b feature-branch)
3. Make your changes
4. Ensure your code is properly formatted (make format)
5. Commit your changes (git commit -m 'Add some feature')
6. Push to the branch (git push origin feature-branch)
7. Open a pull request

License

This project is licensed under the BSD 3-Clause License. See the LICENSE file.