Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (47 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

68 lines (47 loc) · 1.32 KB

1. Contributing

1.1. Setup Development Environment

1.1.1. Toolchain

  • Install python 3.11 or newer

1.1.2. VSCode Extensions

  • Pylance: ms-python.vscode-pylance
  • Tailwind CSS Intellisense: bradlc.vscode-tailwindcss
  • Jinja: wholroyd.jinja
  • Jinja2 Snippet Kit: wyattferguson.jinja2-snippet-kit
  • BetterJinja: samuelcolvin.jinjahtml
  • Markdown All in One: yzhang.markdown-all-in-one
  • markdownlint: davidanson.vscode-markdownlint

1.1.3. Python Library Dependencies

python -m venv venv
.\venv\Scripts\activate
pip install -r requirements.txt

1.2. Build Package

  1. Run the following commands

    .\venv\Scripts\activate
python setup.py bdist_wheel

  2. Verify the package

    1. Examine the build output files at build/lib/jinja_flowbite
      1. Ensure that all the expected .jinja files are there

1.3. Publishing to PyPi

  1. Install twine

    .\venv\Scripts\activate
pip install twine # if you haven't already

  2. Ensure you have your ~/.pypirc populated

    [pypi]
username = __token__
password = pypi-**********

  3. Update CHANGELOG.md

  4. Publish to PyPI

    1. Update the version number in setup.py

    2. Run the following command

      .\venv\Scripts\activate
.\publish.ps1