Skip to content

Create Python package / Repository refactor

Forum topic in French: Évolutions du dépôt de la licence monétaire Ğ1

Packaging

Rename project

  • From licence-g1 to g1-monetary-license: repository name, package name, folder
    • Rename repository

Software license

It's currently ISC licensed in the package.json Is it not a problem for a non-free software/non-copyleft programs to use these files/package because of the copyleft. The suggestions are GNU FDL or CC-BY-SA 4.0.

  • Add LICENSE file and prepend __init__.py with license's header.

Python package

  • Create package with Poetry
  • Create jobs to publish it on PyPI and PyPI test

Version update

  • Create a script to update the version into package.json, pyproject.toml, and the licenses files.
  • Document the how the version should be changed:
    • Rule evolution: v0.2.9 −> v0.3.0
    • Language addition: 0.3.0 −> 0.3.0-1
    • Rule evolution : v0.3.0-1 −> v0.3.1

Documentation

  • README.md
  • CONTRIBUTING.md
  • CHANGELOG.md
  • LICENSE

v0.3

  • Bump version after all this changes
Edited by Moul
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information