Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 2 KB

DEVELOPMENT.md

File metadata and controls

60 lines (43 loc) · 2 KB
Raw

Planets Math

Planets Math development

Developer Workflow

This project uses the GitHub flow

Getting Started with development

NOTE: This project has a pre-commit config. To install it run pre-commit install from the repository root. You may want to setup automatic notifications for pre-commit enabled repos: https://pre-commit.com/index.html#automatically-enabling-pre-commit-on-repositories

Make sure you have up to date versions of pip, setuptools, and wheel.

python3 -m pip install --upgrade pip setuptools wheel --user

Now you can perform an editable install of the code base.

python3 setup.py develop --user

From here pytest should "just work".

NOTE:

  • For running tests, make sure you have C.UTF-8 locale defined
sudo localedef -v -c -i en_US -f UTF-8 C.UTF-8

Licensing compliance

Planets Math is released under the Apache 2.0 license and license compliance is handled with the REUSE tool. REUSE is installed as development dependency or you can install it manually (pip install reuse). All files should have a license notice:

  • to check compliance you can use reuse lint. This is the command run also by the pre-commit and CI checks
  • you can add on top of new files SPDX license notices like 
    # SPDX-FileCopyrightText: 2022 Fermi Research Alliance, LLC
# SPDX-License-Identifier: Apache-2.0
  • or let REUSE do that for you (FILEPATH is your new file): 
    reuse addheader --year 2022 --copyright="Fermi Research Alliance, LLC" \
  --license="Apache-2.0" --template=compact FILEPATH
  • Files that are not supported and have no comments to add the SPDX notice can be added to the .reuse/dep5 file
  • New licenses can be added to the project using reuse download LCENSEID. Please contact project management if this is needed.