Skip to content

Set Up Environement

The easiest way to get started is to use uv and Git.

Install for development

  • Fork the repository to your own GitHub account.

  • Clone your forked repository to your local machine:

git clone https://github.com/YOURNAME/fleur.git
cd fleur
git remote add upstream https://github.com/y-sunflower/fleur.git
  • Create a new branch:
git checkout -b my-feature
  • Set up your Python environment:
uv sync --all-groups
uv run pre-commit install
uv pip install -e .

Code!

You can now make changes to the package and start coding!

Run the test

  • Test that everything works correctly by running:
uv run pytest

Preview documentation locally

uv run mkdocs serve

Push changes

  • Commit and push your changes:
git add -A
git commit -m "description of what you did"
git push
  • Go back to your fork and click on the "Open a PR" popup

Congrats! Once your PR is merged, it will be part of fleur.