Skip to content

Contribute

Contributions are more than welcome! Submit a pull request, or open an issue and I (Martin) will gladly answer your questions on how to contribute.

Setup a development environment

  1. Clone this repository. git clone https://github.com/Bravos-Power/pyoframe

  2. Install the dependencies. pip install --editable .[dev]

  3. Install the pre-commit hooks. pre-commit install

  4. Run pytest to make sure everything is working. If not, open an issue!

Documentation

We use Material Docs for documentation with several plugins to enable features like automatically compiling the docstrings into the reference API. Please follow the Google style for docstrings.

Helpful commands

  • pytest: Runs all the tests. If you'd like to generate coverage information just add the flag --cov.
  • mkdocs serve: Generates the documentation locally. Navigate to http://127.0.0.1:8000/pyoframe/ to check it out.
  • coverage html: Generate a webpage to view the coverage information generated by pytest.
  • python ./tests/test_examples.py: Regenerate the files in the results folder of an example (e.g. tests/examples/sudoku/results/**). You should only run this if the result files need to be regenerated, for example, if model variable names have changed.
  • ruff check: Ensures all the linter tests pass
  • ruff format: Ensures the code is properly formatted (this is run upon commit if you've installed the pre-commit hooks)

Details for repository maintainers

Expired Gurobi License

We use a Gurobi license to run our tests. If the tests fail an give a license expired error, generate a new one and copy the contents of the guorbi.lic file into the GUROBI_WLS Github secret (Settings -> Secrets and variables -> actions).