Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lazuli v3 Update #3

Merged
merged 47 commits into from
Sep 18, 2022
Merged

Lazuli v3 Update #3

merged 47 commits into from
Sep 18, 2022

Conversation

KOOKIIEStudios
Copy link
Member

Summary of changes

  • Remove distribution- and documentation-related dependencies from requirements
  • Change documentation library from Portray to pdoc
  • Create GitHub Actions workflow for automatic generation of API documentation
  • Reformat docstrings to follow Google style
  • Replace JOBS dictionary in __init__ module with the SpiritSuite YAML document
  • PEP 484 Compliance: add type hints
  • PEP 621 Compliance: Use pyproject.toml, setuptools, and build for distribution
  • Update setup and build scripts

For detailed explanation see: /~https://github.com/TEAM-SPIRIT-Productions/Lazuli/wiki/Migration-from-v2-to-v3

All unit tests passed

Unit tests after installing from TestPyPI:
image

New pypi folder used for distribution to avoid polluting the requirements with twine-related dependencies
Distribution-related and documentation-related dependencies are no longer part of the requirements
Contains documentation- and distribution-related dependencies
Also similar changes to account module, where previously missed. Some non-breaking sanity checks were also added to the character module.
Signed-off-by: KOOKIIEStudios <25145447+KOOKIIEStudios@users.noreply.github.com>
This is to ensure compliance with PEP 621, where pyproject.toml is the new preferred way of handling metadata.
setup.py should not be needed as Lazuli v3 is expected to target Python 3.10 and higher; there are no legacy support concerns.
Signed-off-by: KOOKIIEStudios <25145447+KOOKIIEStudios@users.noreply.github.com>
Obtained from: /~https://github.com/TEAM-SPIRIT-Productions/MapleStoryJobIDs/blob/main/jobid_to_name.yaml - there isn't really a huge need for a CI/CD approach to this right now
New dependency: ruamel.yaml is a YAML 1.2 loader/dumper package for Python, that supports comments.
Signed-off-by: KOOKIIEStudios <25145447+KOOKIIEStudios@users.noreply.github.com>
@KOOKIIEStudios KOOKIIEStudios added the enhancement New feature or request label Sep 18, 2022
Copy link
Member

@Bratah123 Bratah123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@KOOKIIEStudios KOOKIIEStudios merged commit 652b229 into main Sep 18, 2022
@KOOKIIEStudios KOOKIIEStudios deleted the pdoc branch September 18, 2022 23:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants